eventespresso / event-espresso-core

core/EE_Cart.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -260,7 +260,7 @@ 
      * @access  public
      * @param EE_Ticket $ticket
      * @param int       $qty
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws \EE_Error
      */
     public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
@@ -385,7 +385,7 @@ 
      * @save   cart to session
      * @access public
      * @param bool $apply_taxes
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws \EE_Error
      */
     public function save_cart($apply_taxes = true)
@@ -419,7 +419,7 @@ 
 
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

Indentation +410 added lines, -410 removed lines

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

core/EE_Registry.core.php

Doc Comments +1 added lines

@@ -298,6 +298,7 @@
 
     /**
      * @param mixed string | EED_Module $module
+     * @param string $module
      */
     public function add_module($module)
     {

Indentation +1326 added lines, -1326 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -15,1361 +15,1361 @@ 
 class EE_Registry
 {
 
-    /**
-     *    EE_Registry Object
-     *
-     * @var EE_Registry $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     * @access    protected
-     */
-    protected $_dependency_map = null;
-
-    /**
-     * @var array $_class_abbreviations
-     * @access    protected
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @access public
-     * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     *    EE_Cart Object
-     *
-     * @access    public
-     * @var    EE_Cart $CART
-     */
-    public $CART = null;
-
-    /**
-     *    EE_Config Object
-     *
-     * @access    public
-     * @var    EE_Config $CFG
-     */
-    public $CFG = null;
-
-    /**
-     * EE_Network_Config Object
-     *
-     * @access public
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG = null;
-
-    /**
-     *    StdClass object for storing library classes in
-     *
-     * @public LIB
-     * @var StdClass $LIB
-     */
-    public $LIB = null;
-
-    /**
-     *    EE_Request_Handler Object
-     *
-     * @access    public
-     * @var    EE_Request_Handler $REQ
-     */
-    public $REQ = null;
-
-    /**
-     *    EE_Session Object
-     *
-     * @access    public
-     * @var    EE_Session $SSN
-     */
-    public $SSN = null;
-
-    /**
-     * holds the ee capabilities object.
-     *
-     * @since 4.5.0
-     * @var EE_Capabilities
-     */
-    public $CAP = null;
-
-    /**
-     * holds the EE_Message_Resource_Manager object.
-     *
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager
-     */
-    public $MRM = null;
-
-    /**
-     *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @access    public
-     * @var    EE_Addon[]
-     */
-    public $addons = null;
-
-    /**
-     *    $models
-     * @access    public
-     * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     */
-    public $models = array();
-
-    /**
-     *    $modules
-     * @access    public
-     * @var    EED_Module[] $modules
-     */
-    public $modules = null;
-
-    /**
-     *    $shortcodes
-     * @access    public
-     * @var    EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes = null;
-
-    /**
-     *    $widgets
-     * @access    public
-     * @var    WP_Widget[] $widgets
-     */
-    public $widgets = null;
-
-    /**
-     * $non_abstract_db_models
-     * @access public
-     * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     */
-    public $non_abstract_db_models = array();
-
-    /**
-     *    $i18n_js_strings - internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @access    public
-     * @var    array
-     */
-    public static $i18n_js_strings = array();
-
-    /**
-     *    $main_file - path to espresso.php
-     *
-     * @access    public
-     * @var    array
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @access    public
-     * @var ReflectionClass[]
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @access    protected
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry instance
-     */
-    public static function instance(\EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new EE_Registry($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry
-     */
-    protected function __construct(\EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-            )
-        );
-        // class library
-        $this->LIB = new stdClass();
-        $this->addons = new stdClass();
-        $this->modules = new stdClass();
-        $this->shortcodes = new stdClass();
-        $this->widgets = new stdClass();
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader('EE_Request');
-        $this->_set_cached_class(
-            $request_loader(),
-            'EE_Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader('EE_Response');
-        $this->_set_cached_class(
-            $response_loader(),
-            'EE_Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-
-    /**
-     *    init
-     *
-     * @access    public
-     * @return    void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if ( ! class_exists('EE_Module_Request_Router')) {
-                $this->load_core('Module_Request_Router');
-            }
-            $this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads service classes
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads data_migration_scripts
-     *
-     * @access    public
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
-    }
-
-
-
-    /**
-     *    loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
-     * @return EE_Base_Class | bool
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
-            EE_CORE,
-            EE_CLASSES,
-            EE_BUSINESS,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
-            EE_MODELS,
-            EE_CORE,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[$model_name]) ? true : false;
-    }
-
-
-
-    /**
-     *    generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    load_addon
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EE_Addon
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return mixed                    null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        if ( ! class_exists($class_name)) {
-            // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
-            // still doesn't exist ?
-            if ( ! class_exists($class_name)) {
-                return null;
-            }
-        }
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return null|object|bool         null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if ( ! empty($class_prefix) && $class_prefix != 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if ( ! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if loading failed, or we are only loading a file but NOT instantiating an object
-            if ( ! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only ? $loaded : null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * _get_cached_class
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $class_prefix
-     * @return mixed
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-        } else {
-            // have to specify something, but not anything that will conflict
-            $class_abbreviation = 'FANCY_BATMAN_PANTS';
-        }
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        } else if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        } else if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        } else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _resolve_path
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type) ? trim($type, '.') . '.' : '';
-            // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
-            //does the file exist and can be read ?
-            if (is_readable($file_paths[$key])) {
-                return $file_paths[$key];
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * _require_file
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @access protected
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if ( ! $path) {
-                // so sorry, can't find the file
-                throw new EE_Error (
-                    sprintf(
-                        __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @access protected
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null | object
-     * @throws \EE_Error
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        $class_obj = null;
-        $instantiation_mode = '0) none';
-        // don't give up! you gotta...
-        try {
-            // create reflection
-            $reflector = $this->get_ReflectionClass($class_name);
-            // make sure arguments are an array
-            $arguments = is_array($arguments) ? $arguments : array($arguments);
-            // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-            // else wrap it in an additional array so that it doesn't get split into multiple parameters
-            $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-                ? $arguments
-                : array($arguments);
-            // attempt to inject dependencies ?
-            if ($this->_dependency_map->has($class_name)) {
-                $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-            }
-            // instantiate the class if possible
-            if ($reflector->isAbstract()) {
-                // nothing to instantiate, loading file was enough
-                // does not throw an exception so $instantiation_mode is unused
-                // $instantiation_mode = "1) no constructor abstract class";
-                $class_obj = true;
-            } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
-                // no constructor = static methods only... nothing to instantiate, loading file was enough
-                $instantiation_mode = "2) no constructor but instantiable";
-                $class_obj = $reflector->newInstance();
-            } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-                $instantiation_mode = "3) new_instance_from_db()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-            } else if (method_exists($class_name, 'new_instance')) {
-                $instantiation_mode = "4) new_instance()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
-            } else if (method_exists($class_name, 'instance')) {
-                $instantiation_mode = "5) instance()";
-                $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
-            } else if ($reflector->isInstantiable()) {
-                $instantiation_mode = "6) constructor";
-                $class_obj = $reflector->newInstanceArgs($arguments);
-            } else {
-                // heh ? something's not right !
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s could not be instantiated.', 'event_espresso'),
-                        $type,
-                        $class_name
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            if ( ! $e instanceof EE_Error) {
-                $e = new EE_Error(
-                    sprintf(
-                        __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
-                        $class_name,
-                        '<br />',
-                        $e->getMessage(),
-                        $instantiation_mode
-                    )
-                );
-            }
-            $e->get_error();
-        }
-        return $class_obj;
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @access protected
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws \ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : null;
-            if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
-            } else {
-                try {
-                    $arguments[$index] = $param->getDefaultValue();
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            __('%1$s for parameter "$%2$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName()
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
-                    !== EE_Dependency_Map::load_new_object
-            ? true
-            : false;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } else if ($param_class != $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader();
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if (method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = $this->create($param_class, array(), $cache_on);
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            if (isset($argument_keys[$index])) {
-                $arguments[$argument_keys[$index]] = $dependency;
-            } else {
-                $arguments[$index] = $dependency;
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @access protected
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @return void
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        if (empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-            $this->{$class_abbreviation} = $class_obj;
-        } else if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-        } else if ($class_prefix == 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-        } else if ( ! $from_db) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        } else if (method_exists(EE_Registry::instance(), $loader)) {
-            return EE_Registry::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the classname as the property name on EE_Config::instance()->addons)
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() == $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
-     * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[$addon->name()] = $addon;
-        }
-        return $addons;
-    }
-
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
-        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        //get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
-     * is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
-     *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             whether to reset data in the database too, or just refresh
-     *                                  the Registry to its state at the beginning of the request
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
-     *                                  currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
-     *                                  code instead can just change the model context to a different blog id if necessary
-     * @return EE_Registry
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        EEH_Activation::reset();
-        //properties that get reset
-        $instance->_cache_on = true;
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        //messages reset
-        EED_Messages::reset();
-        if ($reset_models) {
-            foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
-                $instance->reset_model($model_name);
-            }
-        }
-        $instance->LIB = new stdClass();
-        return $instance;
-    }
-
-
-
-    /**
-     * @override magic methods
-     * @return void
-     */
-    final function __destruct()
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __call($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    final function __get($a)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __set($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    final function __isset($a)
-    {
-    }
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var EE_Registry $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 * @access    protected
+	 */
+	protected $_dependency_map = null;
+
+	/**
+	 * @var array $_class_abbreviations
+	 * @access    protected
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @access public
+	 * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 *    EE_Cart Object
+	 *
+	 * @access    public
+	 * @var    EE_Cart $CART
+	 */
+	public $CART = null;
+
+	/**
+	 *    EE_Config Object
+	 *
+	 * @access    public
+	 * @var    EE_Config $CFG
+	 */
+	public $CFG = null;
+
+	/**
+	 * EE_Network_Config Object
+	 *
+	 * @access public
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG = null;
+
+	/**
+	 *    StdClass object for storing library classes in
+	 *
+	 * @public LIB
+	 * @var StdClass $LIB
+	 */
+	public $LIB = null;
+
+	/**
+	 *    EE_Request_Handler Object
+	 *
+	 * @access    public
+	 * @var    EE_Request_Handler $REQ
+	 */
+	public $REQ = null;
+
+	/**
+	 *    EE_Session Object
+	 *
+	 * @access    public
+	 * @var    EE_Session $SSN
+	 */
+	public $SSN = null;
+
+	/**
+	 * holds the ee capabilities object.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Capabilities
+	 */
+	public $CAP = null;
+
+	/**
+	 * holds the EE_Message_Resource_Manager object.
+	 *
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager
+	 */
+	public $MRM = null;
+
+	/**
+	 *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @access    public
+	 * @var    EE_Addon[]
+	 */
+	public $addons = null;
+
+	/**
+	 *    $models
+	 * @access    public
+	 * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 */
+	public $models = array();
+
+	/**
+	 *    $modules
+	 * @access    public
+	 * @var    EED_Module[] $modules
+	 */
+	public $modules = null;
+
+	/**
+	 *    $shortcodes
+	 * @access    public
+	 * @var    EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes = null;
+
+	/**
+	 *    $widgets
+	 * @access    public
+	 * @var    WP_Widget[] $widgets
+	 */
+	public $widgets = null;
+
+	/**
+	 * $non_abstract_db_models
+	 * @access public
+	 * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 */
+	public $non_abstract_db_models = array();
+
+	/**
+	 *    $i18n_js_strings - internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public static $i18n_js_strings = array();
+
+	/**
+	 *    $main_file - path to espresso.php
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @access    public
+	 * @var ReflectionClass[]
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @access    protected
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry instance
+	 */
+	public static function instance(\EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new EE_Registry($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry
+	 */
+	protected function __construct(\EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+			)
+		);
+		// class library
+		$this->LIB = new stdClass();
+		$this->addons = new stdClass();
+		$this->modules = new stdClass();
+		$this->shortcodes = new stdClass();
+		$this->widgets = new stdClass();
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader('EE_Request');
+		$this->_set_cached_class(
+			$request_loader(),
+			'EE_Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader('EE_Response');
+		$this->_set_cached_class(
+			$response_loader(),
+			'EE_Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+
+	/**
+	 *    init
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if ( ! class_exists('EE_Module_Request_Router')) {
+				$this->load_core('Module_Request_Router');
+			}
+			$this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads service classes
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads data_migration_scripts
+	 *
+	 * @access    public
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
+	}
+
+
+
+	/**
+	 *    loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
+	 * @return EE_Base_Class | bool
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
+			EE_CORE,
+			EE_CLASSES,
+			EE_BUSINESS,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
+			EE_MODELS,
+			EE_CORE,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[$model_name]) ? true : false;
+	}
+
+
+
+	/**
+	 *    generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    load_addon
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EE_Addon
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return mixed                    null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		if ( ! class_exists($class_name)) {
+			// maybe the class is registered with a preceding \
+			$class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+			// still doesn't exist ?
+			if ( ! class_exists($class_name)) {
+				return null;
+			}
+		}
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return null|object|bool         null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if ( ! empty($class_prefix) && $class_prefix != 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if ( ! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if loading failed, or we are only loading a file but NOT instantiating an object
+			if ( ! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only ? $loaded : null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * _get_cached_class
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @return mixed
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+		} else {
+			// have to specify something, but not anything that will conflict
+			$class_abbreviation = 'FANCY_BATMAN_PANTS';
+		}
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		} else if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		} else if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		} else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _resolve_path
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
+			// prep file type
+			$type = ! empty($type) ? trim($type, '.') . '.' : '';
+			// build full file path
+			$file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+			//does the file exist and can be read ?
+			if (is_readable($file_paths[$key])) {
+				return $file_paths[$key];
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * _require_file
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @access protected
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if ( ! $path) {
+				// so sorry, can't find the file
+				throw new EE_Error (
+					sprintf(
+						__('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null | object
+	 * @throws \EE_Error
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		$class_obj = null;
+		$instantiation_mode = '0) none';
+		// don't give up! you gotta...
+		try {
+			// create reflection
+			$reflector = $this->get_ReflectionClass($class_name);
+			// make sure arguments are an array
+			$arguments = is_array($arguments) ? $arguments : array($arguments);
+			// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+			// else wrap it in an additional array so that it doesn't get split into multiple parameters
+			$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+				? $arguments
+				: array($arguments);
+			// attempt to inject dependencies ?
+			if ($this->_dependency_map->has($class_name)) {
+				$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+			}
+			// instantiate the class if possible
+			if ($reflector->isAbstract()) {
+				// nothing to instantiate, loading file was enough
+				// does not throw an exception so $instantiation_mode is unused
+				// $instantiation_mode = "1) no constructor abstract class";
+				$class_obj = true;
+			} else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
+				// no constructor = static methods only... nothing to instantiate, loading file was enough
+				$instantiation_mode = "2) no constructor but instantiable";
+				$class_obj = $reflector->newInstance();
+			} else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+				$instantiation_mode = "3) new_instance_from_db()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+			} else if (method_exists($class_name, 'new_instance')) {
+				$instantiation_mode = "4) new_instance()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
+			} else if (method_exists($class_name, 'instance')) {
+				$instantiation_mode = "5) instance()";
+				$class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
+			} else if ($reflector->isInstantiable()) {
+				$instantiation_mode = "6) constructor";
+				$class_obj = $reflector->newInstanceArgs($arguments);
+			} else {
+				// heh ? something's not right !
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s could not be instantiated.', 'event_espresso'),
+						$type,
+						$class_name
+					)
+				);
+			}
+		} catch (Exception $e) {
+			if ( ! $e instanceof EE_Error) {
+				$e = new EE_Error(
+					sprintf(
+						__('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
+						$class_name,
+						'<br />',
+						$e->getMessage(),
+						$instantiation_mode
+					)
+				);
+			}
+			$e->get_error();
+		}
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @access protected
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws \ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : null;
+			if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, and should be injected
+				! empty($param_class)
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
+			} else {
+				try {
+					$arguments[$index] = $param->getDefaultValue();
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							__('%1$s for parameter "$%2$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName()
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
+					!== EE_Dependency_Map::load_new_object
+			? true
+			: false;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} else if ($param_class != $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader();
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if (method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = $this->create($param_class, array(), $cache_on);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			if (isset($argument_keys[$index])) {
+				$arguments[$argument_keys[$index]] = $dependency;
+			} else {
+				$arguments[$index] = $dependency;
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @access protected
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @return void
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		if (empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+			$this->{$class_abbreviation} = $class_obj;
+		} else if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+		} else if ($class_prefix == 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+		} else if ( ! $from_db) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		} else if (method_exists(EE_Registry::instance(), $loader)) {
+			return EE_Registry::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the classname as the property name on EE_Config::instance()->addons)
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() == $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
+	 * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[$addon->name()] = $addon;
+		}
+		return $addons;
+	}
+
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
+		if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		//get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
+	 * is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
+	 *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             whether to reset data in the database too, or just refresh
+	 *                                  the Registry to its state at the beginning of the request
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
+	 *                                  currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
+	 *                                  code instead can just change the model context to a different blog id if necessary
+	 * @return EE_Registry
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		EEH_Activation::reset();
+		//properties that get reset
+		$instance->_cache_on = true;
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		//messages reset
+		EED_Messages::reset();
+		if ($reset_models) {
+			foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
+				$instance->reset_model($model_name);
+			}
+		}
+		$instance->LIB = new stdClass();
+		return $instance;
+	}
+
+
+
+	/**
+	 * @override magic methods
+	 * @return void
+	 */
+	final function __destruct()
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __call($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __get($a)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __set($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __isset($a)
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     */
-    final function __unset($a)
-    {
-    }
+	/**
+	 * @param $a
+	 */
+	final function __unset($a)
+	{
+	}
 
 
 
-    /**
-     * @return array
-     */
-    final function __sleep()
-    {
-        return array();
-    }
+	/**
+	 * @return array
+	 */
+	final function __sleep()
+	{
+		return array();
+	}
 
 
 
-    final function __wakeup()
-    {
-    }
+	final function __wakeup()
+	{
+	}
 
 
 
-    /**
-     * @return string
-     */
-    final function __toString()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	final function __toString()
+	{
+		return '';
+	}
 
 
 
-    final function __invoke()
-    {
-    }
+	final function __invoke()
+	{
+	}
 
 
 
-    final function __set_state()
-    {
-    }
+	final function __set_state()
+	{
+	}
 
 
 
-    final function __clone()
-    {
-    }
+	final function __clone()
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     * @param $b
-     */
-    final static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final static function __callStatic($a, $b)
+	{
+	}
 
 
 
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[$short_name] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[$short_name] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
 
 
 
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
 
 
 }

Spacing +21 added lines, -21 removed lines

@@ -285,13 +285,13 @@ 
      */
     public static function localize_i18n_js_strings()
     {
-        $i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
+        $i18n_js_strings = (array) EE_Registry::$i18n_js_strings;
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
-                $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
             }
         }
-        return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return "/* <![CDATA[ */ var eei18n = ".wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -342,9 +342,9 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
+                EE_CORE.'data_migration_scripts'.DS,
+                EE_CORE.'request_stack'.DS,
+                EE_CORE.'middleware'.DS,
             )
         );
         // retrieve instantiated class
@@ -367,7 +367,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services' . DS,
+                EE_CORE.'services'.DS,
             )
         );
         // retrieve instantiated class
@@ -447,10 +447,10 @@ 
     {
         $paths = array(
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
+            EE_LIBRARIES.'messages'.DS,
+            EE_LIBRARIES.'shortcodes'.DS,
+            EE_LIBRARIES.'qtips'.DS,
+            EE_LIBRARIES.'payment_methods'.DS,
         );
         // retrieve instantiated class
         return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
@@ -489,10 +489,10 @@ 
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
     {
         $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
+            EE_MODELS.'fields'.DS,
+            EE_MODELS.'helpers'.DS,
+            EE_MODELS.'relations'.DS,
+            EE_MODELS.'strategies'.DS,
         );
         // retrieve instantiated class
         return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
@@ -578,7 +578,7 @@ 
         $class_name = $this->_dependency_map->get_alias($class_name);
         if ( ! class_exists($class_name)) {
             // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+            $class_name = strpos($class_name, '\\') !== 0 ? '\\'.$class_name : $class_name;
             // still doesn't exist ?
             if ( ! class_exists($class_name)) {
                 return null;
@@ -644,7 +644,7 @@ 
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name = $this->_dependency_map->get_alias($class_name);
         $class_exists = class_exists($class_name);
@@ -744,9 +744,9 @@ 
             // convert all separators to proper DS, if no filepath, then use EE_CLASSES
             $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
             // prep file type
-            $type = ! empty($type) ? trim($type, '.') . '.' : '';
+            $type = ! empty($type) ? trim($type, '.').'.' : '';
             // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php';
             //does the file exist and can be read ?
             if (is_readable($file_paths[$key])) {
                 return $file_paths[$key];
@@ -777,12 +777,12 @@ 
             //does the file exist and can it be read ?
             if ( ! $path) {
                 // so sorry, can't find the file
-                throw new EE_Error (
+                throw new EE_Error(
                     sprintf(
                         __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }

core/helpers/EEH_Activation.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -613,7 +613,7 @@ 
      *
      * @since  4.6.0
      * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
+     * @return integer|null null|int WP_user ID or NULL
      */
     public static function get_default_creator_id()
     {
@@ -774,7 +774,7 @@ 
      * @static
      * @deprecated instead use TableManager::dropTable()
      * @param string $table_name
-     * @return bool | int
+     * @return integer | int
      */
     public static function delete_unused_db_table($table_name)
     {
@@ -791,7 +791,7 @@ 
      * @deprecated instead use TableManager::dropIndex()
      * @param string $table_name
      * @param string $index_name
-     * @return bool | int
+     * @return integer | int
      */
     public static function drop_index($table_name, $index_name)
     {

Indentation +1650 added lines, -1650 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,236 +14,236 @@ 
 class EEH_Activation
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * option name that will indicate whether or not we still
-     * need to create EE's folders in the uploads directory
-     * (because if EE was installed without file system access,
-     * we need to request credentials before we can create them)
-     */
-    const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
-
-    /**
-     * 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 \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableAnalysis
-     */
-    public static function getTableAnalysis()
-    {
-        if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        }
-        return self::$table_analysis;
-    }
-
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableManager
-     */
-    public static function getTableManager()
-    {
-        if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        }
-        return self::$table_manager;
-    }
-
-
-
-    /**
-     *    _ensure_table_name_has_prefix
-     *
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     * @access     public
-     * @static
-     * @param $table_name
-     * @return string
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-
-    /**
-     *    system_initialization
-     *    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
-     *
-     * @access public
-     * @static
-     * @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
-     */
-    public static function initialize_db_and_folders()
-    {
-        $good_filesystem = EEH_Activation::create_upload_directories();
-        $good_db = EEH_Activation::create_database_tables();
-        return $good_filesystem && $good_db;
-    }
-
-
-
-    /**
-     * 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
-     */
-    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::create_no_ticket_prices_array();
-        EE_Registry::instance()->CAP->init_caps();
-        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',
-            array(
-                '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
-            )
-        );
-        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(
-                    __(
-                        '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)) {
-                wp_schedule_event(time(), $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 : array();
-        /* 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';
+
+	/**
+	 * option name that will indicate whether or not we still
+	 * need to create EE's folders in the uploads directory
+	 * (because if EE was installed without file system access,
+	 * we need to request credentials before we can create them)
+	 */
+	const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
+
+	/**
+	 * 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 \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableAnalysis
+	 */
+	public static function getTableAnalysis()
+	{
+		if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		}
+		return self::$table_analysis;
+	}
+
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableManager
+	 */
+	public static function getTableManager()
+	{
+		if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		}
+		return self::$table_manager;
+	}
+
+
+
+	/**
+	 *    _ensure_table_name_has_prefix
+	 *
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 * @access     public
+	 * @static
+	 * @param $table_name
+	 * @return string
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+
+	/**
+	 *    system_initialization
+	 *    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
+	 *
+	 * @access public
+	 * @static
+	 * @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
+	 */
+	public static function initialize_db_and_folders()
+	{
+		$good_filesystem = EEH_Activation::create_upload_directories();
+		$good_db = EEH_Activation::create_database_tables();
+		return $good_filesystem && $good_db;
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	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::create_no_ticket_prices_array();
+		EE_Registry::instance()->CAP->init_caps();
+		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',
+			array(
+				'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
+			)
+		);
+		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(
+					__(
+						'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)) {
+				wp_schedule_event(time(), $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 : array();
+		/* 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.
@@ -260,908 +260,908 @@ 
          *					...
          *      ...
          */
-        $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);
-    }
-
-
-
-    /**
-     *    CPT_initialization
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-
-    /**
-     *    reset_and_update_config
-     * 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.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter('FHEE__EE_Config___load_core_config__config_settings', array('EEH_Activation', 'migrate_old_config_data'), 10, 3);
-        //EE_Config::reset();
-        if ( ! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-
-    /**
-     *    load_calendar_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', 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 . DS . 'EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = 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;
-    }
-
-
-
-    /**
-     * deactivate_event_espresso
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('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 = __('The Event Espresso critical page configuration settings could not be updated.', 'event_espresso');
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // track post_shortcodes
-            if ($critical_page['post']) {
-                EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
-            }
-            // 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 = __('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) {
-            $msg = sprintf(
-                __('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') . '">' . __('Event Espresso Critical Pages Settings', 'event_espresso') . '</a>'
-            );
-            EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, 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;
-        }
-        //		return $post_id;
-    }
-
-
-
-    /**
-     *    This function generates a post for critical espresso pages
-     *
-     * @access public
-     * @static
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-        $post_args = array(
-            '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(
-                __('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(
-                __('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;
-    }
-
-
-
-    /**
-     *    This function adds a critical page's shortcode to the post_shortcodes array
-     *
-     * @access private
-     * @static
-     * @param array $critical_page
-     * @return void
-     */
-    private static function _track_critical_page_post_shortcodes($critical_page = array())
-    {
-        // check the goods
-        if ( ! $critical_page['post'] instanceof WP_Post) {
-            $msg = sprintf(
-                __('The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        // map shortcode to post
-        $EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
-        // and make sure it's NOT added to the WP "Posts Page"
-        // name of the WP Posts Page
-        $posts_page = EE_Config::get_page_for_posts();
-        if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
-            unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
-        }
-        if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
-            unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
-        }
-        // update post_shortcode CFG
-        if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page shortcode for the %s page could not be configured properly.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * 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.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    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.
-     *
-     * @access public
-     * @static
-     * @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
-     */
-    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);
-            } else if ( ! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                EE_Error::add_persistent_admin_notice(
-                    'bad_table_' . $wp_table_name . '_detected',
-                    sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
-                        'event_espresso'),
-                        $wp_table_name,
-                        "<pre>define( 'EE_DROP_BAD_TABLES', TRUE );</pre>",
-                        '<b>wp-config.php</b>',
-                        '<br/>'),
-                    true);
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @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
-     */
-    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);
-    }
-
-
-
-    /**
-     * get_fields_on_table
-     * Gets all the fields on the database table.
-     *
-     * @access     public
-     * @deprecated instead use TableManager::getTableColumns()
-     * @static
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-
-    /**
-     * db_table_is_empty
-     *
-     * @access     public\
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     * @static
-     * @param string $table_name
-     * @return bool
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-
-    /**
-     * delete_db_table_if_empty
-     *
-     * @access public
-     * @static
-     * @param string $table_name
-     * @return bool | int
-     */
-    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;
-    }
-
-
-
-    /**
-     * delete_unused_db_table
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropTable()
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-
-    /**
-     * drop_index
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropIndex()
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool | int
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    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) {
-            $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(__('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();
-        } else {
-            EE_Error::add_error(__('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;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    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 : array();
-        // what we should have
-        $QSG_systems = array(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 = array();
-            // 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 = array(
-                            'QSG_name'            => __('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 = array(
-                            'QSG_name'            => __('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,
-                        array('%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);
-        // what we should have
-        $QST_systems = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'country',
-            'state',
-            'zip',
-            'phone',
-        );
-        $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 = array();
-            // if we don't have what we should have
-            if ( ! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('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 = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('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 = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('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 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('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 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('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 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('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 'country' :
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('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 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            '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 = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('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;
-                }
-                if ( ! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } else {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    }
-                    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(array(array('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(
-                                    __('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'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%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
-     */
-    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();
-        }
-    }
-
-
-
-    /**
-     * insert_default_status_codes
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    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' );";
-            $wpdb->query($SQL);
-            $SQL = "INSERT INTO $table_name
+		$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);
+	}
+
+
+
+	/**
+	 *    CPT_initialization
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+
+	/**
+	 *    reset_and_update_config
+	 * 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.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter('FHEE__EE_Config___load_core_config__config_settings', array('EEH_Activation', 'migrate_old_config_data'), 10, 3);
+		//EE_Config::reset();
+		if ( ! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+
+	/**
+	 *    load_calendar_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . DS . '*', 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 . DS . 'EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = 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;
+	}
+
+
+
+	/**
+	 * deactivate_event_espresso
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('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 = __('The Event Espresso critical page configuration settings could not be updated.', 'event_espresso');
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// track post_shortcodes
+			if ($critical_page['post']) {
+				EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
+			}
+			// 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 = __('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) {
+			$msg = sprintf(
+				__('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') . '">' . __('Event Espresso Critical Pages Settings', 'event_espresso') . '</a>'
+			);
+			EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, 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;
+		}
+		//		return $post_id;
+	}
+
+
+
+	/**
+	 *    This function generates a post for critical espresso pages
+	 *
+	 * @access public
+	 * @static
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+		$post_args = array(
+			'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(
+				__('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(
+				__('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;
+	}
+
+
+
+	/**
+	 *    This function adds a critical page's shortcode to the post_shortcodes array
+	 *
+	 * @access private
+	 * @static
+	 * @param array $critical_page
+	 * @return void
+	 */
+	private static function _track_critical_page_post_shortcodes($critical_page = array())
+	{
+		// check the goods
+		if ( ! $critical_page['post'] instanceof WP_Post) {
+			$msg = sprintf(
+				__('The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		// map shortcode to post
+		$EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
+		// and make sure it's NOT added to the WP "Posts Page"
+		// name of the WP Posts Page
+		$posts_page = EE_Config::get_page_for_posts();
+		if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
+			unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
+		}
+		if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
+			unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
+		}
+		// update post_shortcode CFG
+		if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page shortcode for the %s page could not be configured properly.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * 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.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	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.
+	 *
+	 * @access public
+	 * @static
+	 * @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
+	 */
+	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);
+			} else if ( ! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				EE_Error::add_persistent_admin_notice(
+					'bad_table_' . $wp_table_name . '_detected',
+					sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
+						'event_espresso'),
+						$wp_table_name,
+						"<pre>define( 'EE_DROP_BAD_TABLES', TRUE );</pre>",
+						'<b>wp-config.php</b>',
+						'<br/>'),
+					true);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @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
+	 */
+	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);
+	}
+
+
+
+	/**
+	 * get_fields_on_table
+	 * Gets all the fields on the database table.
+	 *
+	 * @access     public
+	 * @deprecated instead use TableManager::getTableColumns()
+	 * @static
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+
+	/**
+	 * db_table_is_empty
+	 *
+	 * @access     public\
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 * @static
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+
+	/**
+	 * delete_db_table_if_empty
+	 *
+	 * @access public
+	 * @static
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	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;
+	}
+
+
+
+	/**
+	 * delete_unused_db_table
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropTable()
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+
+	/**
+	 * drop_index
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropIndex()
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool | int
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	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) {
+			$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(__('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();
+		} else {
+			EE_Error::add_error(__('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;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	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 : array();
+		// what we should have
+		$QSG_systems = array(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 = array();
+			// 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 = array(
+							'QSG_name'            => __('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 = array(
+							'QSG_name'            => __('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,
+						array('%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);
+		// what we should have
+		$QST_systems = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'country',
+			'state',
+			'zip',
+			'phone',
+		);
+		$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 = array();
+			// if we don't have what we should have
+			if ( ! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('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 = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('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 = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('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 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('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 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('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 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('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 'country' :
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('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 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'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 = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('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;
+				}
+				if ( ! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} else {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					}
+					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(array(array('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(
+									__('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'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%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
+	 */
+	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();
+		}
+	}
+
+
+
+	/**
+	 * insert_default_status_codes
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	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' );";
+			$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),
@@ -1199,526 +1199,526 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-        }
-    }
-
-
-
-    /**
-     * create_upload_directories
-     * Creates folders in the uploads directory to facilitate addons and templates
-     *
-     * @access public
-     * @static
-     * @return boolean success of verifying upload directories exist
-     */
-    public static function create_upload_directories()
-    {
-        // Create the required folders
-        $folders = array(
-            EVENT_ESPRESSO_TEMPLATE_DIR,
-            EVENT_ESPRESSO_GATEWAY_DIR,
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
-        );
-        foreach ($folders as $folder) {
-            try {
-                EEH_File::ensure_folder_exists_and_is_writable($folder);
-                @ chmod($folder, 0755);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
-                        $folder,
-                        '<br />' . $e->getMessage()
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //indicate we'll need to fix this later
-                update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
-                return false;
-            }
-        }
-        //just add the .htaccess file to the logs directory to begin with. Even if logging
-        //is disabled, there might be activation errors recorded in there
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
-        //remember EE's folders are all good
-        delete_option(EEH_Activation::upload_directories_incomplete_option_name);
-        return true;
-    }
-
-
-
-    /**
-     * Whether the upload directories need to be fixed or not.
-     * If EE is installed but filesystem access isn't initially available,
-     * we need to get the user's filesystem credentials and THEN create them,
-     * so there might be period of time when EE is installed but its
-     * upload directories aren't available. This indicates such a state
-     *
-     * @return boolean
-     */
-    public static function upload_directories_incomplete()
-    {
-        return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
-    }
-
-
-
-    /**
-     * generate_default_message_templates
-     *
-     * @static
-     * @throws EE_Error
-     * @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.
-     */
-    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);
+		}
+	}
+
+
+
+	/**
+	 * create_upload_directories
+	 * Creates folders in the uploads directory to facilitate addons and templates
+	 *
+	 * @access public
+	 * @static
+	 * @return boolean success of verifying upload directories exist
+	 */
+	public static function create_upload_directories()
+	{
+		// Create the required folders
+		$folders = array(
+			EVENT_ESPRESSO_TEMPLATE_DIR,
+			EVENT_ESPRESSO_GATEWAY_DIR,
+			EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
+			EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
+		);
+		foreach ($folders as $folder) {
+			try {
+				EEH_File::ensure_folder_exists_and_is_writable($folder);
+				@ chmod($folder, 0755);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					sprintf(
+						__('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
+						$folder,
+						'<br />' . $e->getMessage()
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//indicate we'll need to fix this later
+				update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
+				return false;
+			}
+		}
+		//just add the .htaccess file to the logs directory to begin with. Even if logging
+		//is disabled, there might be activation errors recorded in there
+		EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
+		//remember EE's folders are all good
+		delete_option(EEH_Activation::upload_directories_incomplete_option_name);
+		return true;
+	}
+
+
+
+	/**
+	 * Whether the upload directories need to be fixed or not.
+	 * If EE is installed but filesystem access isn't initially available,
+	 * we need to get the user's filesystem credentials and THEN create them,
+	 * so there might be period of time when EE is installed but its
+	 * upload directories aren't available. This indicates such a state
+	 *
+	 * @return boolean
+	 */
+	public static function upload_directories_incomplete()
+	{
+		return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
+	}
+
+
+
+	/**
+	 * generate_default_message_templates
+	 *
+	 * @static
+	 * @throws EE_Error
+	 * @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.
+	 */
+	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
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $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 = array();
-            // 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
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $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->name,
-                $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.
-     *
-     * @static
-     * @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 = array();
-        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.
-     *
-     * @since 4.3.1
-     * @return void
-     */
-    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');
-    }
-
-
-
-    /**
-     * create_no_ticket_prices_array
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function create_no_ticket_prices_array()
-    {
-        // this creates an array for tracking events that have no active ticket prices created
-        // this allows us to warn admins of the situation so that it can be corrected
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if ( ! $espresso_no_ticket_prices) {
-            add_option('ee_no_ticket_prices', array(), '', false);
-        }
-    }
-
-
-
-    /**
-     * plugin_deactivation
-     *
-     * @access public
-     * @static
-     * @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)
-     *
-     * @global wpdb $wpdb
-     * @throws \EE_Error
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        //get all the CPT post_types
-        $ee_post_types = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($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
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = array();
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($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();
-                        }
-                    }
-                }
-            }
-        }
-        //there are some tables whose models were removed.
-        //they should be removed when removing all EE core's data
-        $tables_without_models = array(
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        );
-        foreach ($tables_without_models as $table) {
-            $tables[] = $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
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            'ee_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,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        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', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            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(
-                __('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()
-    {
-        global $wpdb;
-        if ($wpdb->use_mysqli) {
-            return mysqli_errno($wpdb->dbh);
-        } else {
-            return mysql_errno($wpdb->dbh);
-        }
-    }
-
-
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     */
-    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;
-    }
+		$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
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$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 = array();
+			// 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
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$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->name,
+				$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.
+	 *
+	 * @static
+	 * @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 = array();
+		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.
+	 *
+	 * @since 4.3.1
+	 * @return void
+	 */
+	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');
+	}
+
+
+
+	/**
+	 * create_no_ticket_prices_array
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function create_no_ticket_prices_array()
+	{
+		// this creates an array for tracking events that have no active ticket prices created
+		// this allows us to warn admins of the situation so that it can be corrected
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
+		if ( ! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', false);
+		}
+	}
+
+
+
+	/**
+	 * plugin_deactivation
+	 *
+	 * @access public
+	 * @static
+	 * @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)
+	 *
+	 * @global wpdb $wpdb
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		//get all the CPT post_types
+		$ee_post_types = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($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
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = array();
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($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();
+						}
+					}
+				}
+			}
+		}
+		//there are some tables whose models were removed.
+		//they should be removed when removing all EE core's data
+		$tables_without_models = array(
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		);
+		foreach ($tables_without_models as $table) {
+			$tables[] = $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
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			'ee_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,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		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', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			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(
+				__('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()
+	{
+		global $wpdb;
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
+		} else {
+			return mysql_errno($wpdb->dbh);
+		}
+	}
+
+
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 */
+	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;
+	}
 }
 // End of file EEH_Activation.helper.php
 // Location: /helpers/EEH_Activation.core.php

Spacing +21 added lines, -21 removed lines

@@ -194,7 +194,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;
                 }
             );
@@ -329,7 +329,7 @@ 
     public static function load_calendar_config()
     {
         // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+        $plugins = glob(WP_PLUGIN_DIR.DS.'*', GLOB_ONLYDIR);
         if (empty($plugins)) {
             return;
         }
@@ -346,7 +346,7 @@ 
                 || strpos($plugin, 'calendar') !== false
             ) {
                 // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+                $calendar_config = $plugin_path.DS.'EE_Calendar_Config.php';
                 // does it exist in this folder ?
                 if (is_readable($calendar_config)) {
                     // YEAH! let's load it
@@ -490,7 +490,7 @@ 
         if ($critical_page_problem) {
             $msg = sprintf(
                 __('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') . '">' . __('Event Espresso Critical Pages Settings', 'event_espresso') . '</a>'
+                '<a href="'.admin_url('admin.php?page=espresso_general_settings&action=critical_pages').'">'.__('Event Espresso Critical Pages Settings', 'event_espresso').'</a>'
             );
             EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
         }
@@ -513,7 +513,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) {
             return get_post($post_id);
@@ -540,7 +540,7 @@ 
             '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) {
@@ -625,14 +625,14 @@ 
         //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;
+            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 . '%');
+        $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;
+        if ($user_id && (int) $user_id) {
+            self::$_default_creator_id = (int) $user_id;
             return self::$_default_creator_id;
         } else {
             return null;
@@ -666,7 +666,7 @@ 
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = \EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -680,7 +680,7 @@ 
             } else if ( ! $deleted_safely) {
                 // so we should be more cautious rather than just dropping tables so easily
                 EE_Error::add_persistent_admin_notice(
-                    'bad_table_' . $wp_table_name . '_detected',
+                    'bad_table_'.$wp_table_name.'_detected',
                     sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
                         'event_espresso'),
                         $wp_table_name,
@@ -868,7 +868,7 @@ 
                     case 1:
                         $QSG_values = array(
                             'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -880,7 +880,7 @@ 
                     case 2:
                         $QSG_values = array(
                             'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -1219,9 +1219,9 @@ 
         $folders = array(
             EVENT_ESPRESSO_TEMPLATE_DIR,
             EVENT_ESPRESSO_GATEWAY_DIR,
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'logs/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'css/',
+            EVENT_ESPRESSO_UPLOAD_DIR.'tickets/',
         );
         foreach ($folders as $folder) {
             try {
@@ -1232,7 +1232,7 @@ 
                     sprintf(
                         __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
                         $folder,
-                        '<br />' . $e->getMessage()
+                        '<br />'.$e->getMessage()
                     ),
                     __FILE__, __FUNCTION__, __LINE__
                 );
@@ -1243,7 +1243,7 @@ 
         }
         //just add the .htaccess file to the logs directory to begin with. Even if logging
         //is disabled, there might be activation errors recorded in there
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
+        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR.'logs/');
         //remember EE's folders are all good
         delete_option(EEH_Activation::upload_directories_incomplete_option_name);
         return true;
@@ -1519,7 +1519,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) {
@@ -1658,7 +1658,7 @@ 
         if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
             $db_update_sans_ee4 = array();
             foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
+                if ((string) $version[0] === '3') {//if its NON EE4
                     $db_update_sans_ee4[$version] = $times_activated;
                 }
             }

caffeinated/brewing_regular.php

Indentation +269 added lines, -269 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\services\database\TableAnalysis;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * the purpose of this file is to simply contain any action/filter hook callbacks etc for specific aspects of EE
@@ -27,277 +27,277 @@ 
 class EE_Brewing_Regular extends EE_BASE
 {
 
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-
-    /**
-     * EE_Brewing_Regular constructor.
-     */
-    public function __construct(TableAnalysis $table_analysis)
-    {
-        $this->_table_analysis = $table_analysis;
-        if (defined('EE_CAFF_PATH')) {
-            // activation
-            add_action('AHEE__EEH_Activation__initialize_db_content', array($this, 'initialize_caf_db_content'));
-            // load caff init
-            add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'caffeinated_init'));
-            // remove the "powered by" credit link from receipts and invoices
-            add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
-            // add caffeinated modules
-            add_filter(
-                'FHEE__EE_Config__register_modules__modules_to_register',
-                array($this, 'caffeinated_modules_to_register')
-            );
-            // load caff scripts
-            add_action('wp_enqueue_scripts', array($this, 'enqueue_caffeinated_scripts'), 10);
-            add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
-            add_filter(
-                'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-                array($this, 'caf_payment_methods')
-            );
-            // caffeinated constructed
-            do_action('AHEE__EE_Brewing_Regular__construct__complete');
-            //seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
-            add_filter('FHEE__ee_show_affiliate_links', '__return_false');
-        }
-    }
-
-
-
-    /**
-     * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
-     *
-     * @param array $paths original helper paths array
-     * @return array             new array of paths
-     */
-    public function caf_helper_paths($paths)
-    {
-        $paths[] = EE_CAF_CORE . 'helpers' . DS;
-        return $paths;
-    }
-
-
-
-    /**
-     * Upon brand-new activation, if this is a new activation of CAF, we want to add
-     * some global prices that will show off EE4's capabilities. However, if they're upgrading
-     * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
-     * This action should only be called when EE 4.x.0.P is initially activated.
-     * Right now the only CAF content are these global prices. If there's more in the future, then
-     * we should probably create a caf file to contain it all instead just a function like this.
-     * Right now, we ASSUME the only price types in the system are default ones
-     *
-     * @global wpdb $wpdb
-     */
-    public function initialize_caf_db_content()
-    {
-        global $wpdb;
-        //use same method of getting creator id as the version introducing the change
-        $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table = $wpdb->prefix . "esp_price_type";
-        $price_table = $wpdb->prefix . "esp_price";
-        if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
-            $tax_price_type_count = $wpdb->get_var($SQL);
-            if ($tax_price_type_count <= 1) {
-                $wpdb->insert(
-                    $price_type_table,
-                    array(
-                        'PRT_name'       => __("Regional Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 60,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ),
-                    array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
-                        '%d', //PRT_wp_user
-                    )
-                );
-                //federal tax
-                $result = $wpdb->insert(
-                    $price_type_table,
-                    array(
-                        'PRT_name'       => __("Federal Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 70,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ),
-                    array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
-                        '%d' //PRT_wp_user
-                    )
-                );
-                if ($result) {
-                    $wpdb->insert(
-                        $price_table,
-                        array(
-                            'PRT_ID'         => $wpdb->insert_id,
-                            'PRC_amount'     => 15.00,
-                            'PRC_name'       => __("Sales Tax", "event_espresso"),
-                            'PRC_desc'       => '',
-                            'PRC_is_default' => true,
-                            'PRC_overrides'  => null,
-                            'PRC_deleted'    => false,
-                            'PRC_order'      => 50,
-                            'PRC_parent'     => null,
-                            'PRC_wp_user'    => $default_creator_id,
-                        ),
-                        array(
-                            '%d',//PRT_id
-                            '%f',//PRC_amount
-                            '%s',//PRC_name
-                            '%s',//PRC_desc
-                            '%d',//PRC_is_default
-                            '%d',//PRC_overrides
-                            '%d',//PRC_deleted
-                            '%d',//PRC_order
-                            '%d',//PRC_parent
-                            '%d' //PRC_wp_user
-                        )
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    caffeinated_modules_to_register
-     *
-     * @access public
-     * @param array $modules_to_register
-     * @return array
-     */
-    public function caffeinated_modules_to_register($modules_to_register = array())
-    {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
-            if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
-                $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
-            }
-        }
-        return $modules_to_register;
-    }
-
-
-
-    public function caffeinated_init()
-    {
-        // EE_Register_CPTs hooks
-        add_filter('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array($this, 'filter_taxonomies'), 10);
-        add_filter('FHEE__EE_Register_CPTs__get_CPTs__cpts', array($this, 'filter_cpts'), 10);
-        add_filter('FHEE__EE_Admin__get_extra_nav_menu_pages_items', array($this, 'nav_metabox_items'), 10);
-        EE_Registry::instance()->load_file(EE_CAFF_PATH, 'EE_Caf_Messages', 'class', array(), false);
-        // caffeinated_init__complete hook
-        do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
-    }
-
-
-
-    public function enqueue_caffeinated_scripts()
-    {
-        // sound of crickets...
-    }
-
-
-
-    /**
-     * callbacks below here
-     *
-     * @param array $taxonomy_array
-     * @return array
-     */
-    public function filter_taxonomies(array $taxonomy_array)
-    {
-        $taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
-        return $taxonomy_array;
-    }
-
-
-
-    /**
-     * @param array $cpt_array
-     * @return mixed
-     */
-    public function filter_cpts(array $cpt_array)
-    {
-        $cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
-        return $cpt_array;
-    }
-
-
-
-    /**
-     * @param array $menuitems
-     * @return array
-     */
-    public function nav_metabox_items(array $menuitems)
-    {
-        $menuitems[] = array(
-            'title'       => __('Venue List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_venues'),
-            'description' => __('Archive page for all venues.', 'event_espresso'),
-        );
-        return $menuitems;
-    }
-
-
-
-    /**
-     * Adds the payment methods in {event-espresso-core}/caffeinated/payment_methods
-     *
-     * @param array $payment_method_paths
-     * @return array values are folder paths to payment method folders
-     */
-    public function caf_payment_methods($payment_method_paths)
-    {
-        $caf_payment_methods_paths = glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        $payment_method_paths = array_merge($payment_method_paths, $caf_payment_methods_paths);
-        return $payment_method_paths;
-    }
-
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+
+	/**
+	 * EE_Brewing_Regular constructor.
+	 */
+	public function __construct(TableAnalysis $table_analysis)
+	{
+		$this->_table_analysis = $table_analysis;
+		if (defined('EE_CAFF_PATH')) {
+			// activation
+			add_action('AHEE__EEH_Activation__initialize_db_content', array($this, 'initialize_caf_db_content'));
+			// load caff init
+			add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'caffeinated_init'));
+			// remove the "powered by" credit link from receipts and invoices
+			add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
+			// add caffeinated modules
+			add_filter(
+				'FHEE__EE_Config__register_modules__modules_to_register',
+				array($this, 'caffeinated_modules_to_register')
+			);
+			// load caff scripts
+			add_action('wp_enqueue_scripts', array($this, 'enqueue_caffeinated_scripts'), 10);
+			add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
+			add_filter(
+				'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+				array($this, 'caf_payment_methods')
+			);
+			// caffeinated constructed
+			do_action('AHEE__EE_Brewing_Regular__construct__complete');
+			//seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
+			add_filter('FHEE__ee_show_affiliate_links', '__return_false');
+		}
+	}
+
+
+
+	/**
+	 * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
+	 *
+	 * @param array $paths original helper paths array
+	 * @return array             new array of paths
+	 */
+	public function caf_helper_paths($paths)
+	{
+		$paths[] = EE_CAF_CORE . 'helpers' . DS;
+		return $paths;
+	}
+
+
+
+	/**
+	 * Upon brand-new activation, if this is a new activation of CAF, we want to add
+	 * some global prices that will show off EE4's capabilities. However, if they're upgrading
+	 * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
+	 * This action should only be called when EE 4.x.0.P is initially activated.
+	 * Right now the only CAF content are these global prices. If there's more in the future, then
+	 * we should probably create a caf file to contain it all instead just a function like this.
+	 * Right now, we ASSUME the only price types in the system are default ones
+	 *
+	 * @global wpdb $wpdb
+	 */
+	public function initialize_caf_db_content()
+	{
+		global $wpdb;
+		//use same method of getting creator id as the version introducing the change
+		$default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
+		$price_type_table = $wpdb->prefix . "esp_price_type";
+		$price_table = $wpdb->prefix . "esp_price";
+		if ($this->_get_table_analysis()->tableExists($price_type_table)) {
+			$SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
+			$tax_price_type_count = $wpdb->get_var($SQL);
+			if ($tax_price_type_count <= 1) {
+				$wpdb->insert(
+					$price_type_table,
+					array(
+						'PRT_name'       => __("Regional Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 60,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					),
+					array(
+						'%s',//PRT_name
+						'%d',//PBT_id
+						'%d',//PRT_is_percent
+						'%d',//PRT_order
+						'%d',//PRT_deleted
+						'%d', //PRT_wp_user
+					)
+				);
+				//federal tax
+				$result = $wpdb->insert(
+					$price_type_table,
+					array(
+						'PRT_name'       => __("Federal Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 70,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					),
+					array(
+						'%s',//PRT_name
+						'%d',//PBT_id
+						'%d',//PRT_is_percent
+						'%d',//PRT_order
+						'%d',//PRT_deleted
+						'%d' //PRT_wp_user
+					)
+				);
+				if ($result) {
+					$wpdb->insert(
+						$price_table,
+						array(
+							'PRT_ID'         => $wpdb->insert_id,
+							'PRC_amount'     => 15.00,
+							'PRC_name'       => __("Sales Tax", "event_espresso"),
+							'PRC_desc'       => '',
+							'PRC_is_default' => true,
+							'PRC_overrides'  => null,
+							'PRC_deleted'    => false,
+							'PRC_order'      => 50,
+							'PRC_parent'     => null,
+							'PRC_wp_user'    => $default_creator_id,
+						),
+						array(
+							'%d',//PRT_id
+							'%f',//PRC_amount
+							'%s',//PRC_name
+							'%s',//PRC_desc
+							'%d',//PRC_is_default
+							'%d',//PRC_overrides
+							'%d',//PRC_deleted
+							'%d',//PRC_order
+							'%d',//PRC_parent
+							'%d' //PRC_wp_user
+						)
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    caffeinated_modules_to_register
+	 *
+	 * @access public
+	 * @param array $modules_to_register
+	 * @return array
+	 */
+	public function caffeinated_modules_to_register($modules_to_register = array())
+	{
+		if (is_readable(EE_CAFF_PATH . 'modules')) {
+			$caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
+			if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
+				$modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
+			}
+		}
+		return $modules_to_register;
+	}
+
+
+
+	public function caffeinated_init()
+	{
+		// EE_Register_CPTs hooks
+		add_filter('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array($this, 'filter_taxonomies'), 10);
+		add_filter('FHEE__EE_Register_CPTs__get_CPTs__cpts', array($this, 'filter_cpts'), 10);
+		add_filter('FHEE__EE_Admin__get_extra_nav_menu_pages_items', array($this, 'nav_metabox_items'), 10);
+		EE_Registry::instance()->load_file(EE_CAFF_PATH, 'EE_Caf_Messages', 'class', array(), false);
+		// caffeinated_init__complete hook
+		do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
+	}
+
+
+
+	public function enqueue_caffeinated_scripts()
+	{
+		// sound of crickets...
+	}
+
+
+
+	/**
+	 * callbacks below here
+	 *
+	 * @param array $taxonomy_array
+	 * @return array
+	 */
+	public function filter_taxonomies(array $taxonomy_array)
+	{
+		$taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
+		return $taxonomy_array;
+	}
+
+
+
+	/**
+	 * @param array $cpt_array
+	 * @return mixed
+	 */
+	public function filter_cpts(array $cpt_array)
+	{
+		$cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
+		return $cpt_array;
+	}
+
+
+
+	/**
+	 * @param array $menuitems
+	 * @return array
+	 */
+	public function nav_metabox_items(array $menuitems)
+	{
+		$menuitems[] = array(
+			'title'       => __('Venue List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_venues'),
+			'description' => __('Archive page for all venues.', 'event_espresso'),
+		);
+		return $menuitems;
+	}
+
+
+
+	/**
+	 * Adds the payment methods in {event-espresso-core}/caffeinated/payment_methods
+	 *
+	 * @param array $payment_method_paths
+	 * @return array values are folder paths to payment method folders
+	 */
+	public function caf_payment_methods($payment_method_paths)
+	{
+		$caf_payment_methods_paths = glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		$payment_method_paths = array_merge($payment_method_paths, $caf_payment_methods_paths);
+		return $payment_method_paths;
+	}
+
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }
 
 
 
 $brewing = new EE_Brewing_Regular(
-    EE_Registry::instance()->create('TableAnalysis', array(), true)
+	EE_Registry::instance()->create('TableAnalysis', array(), true)
 );

Spacing +30 added lines, -30 removed lines

@@ -10,10 +10,10 @@ 
  * define and use the hook in a specific caffeinated/whatever class or file.
  */
 // defined some new constants related to caffeinated folder
-define('EE_CAF_URL', EE_PLUGIN_DIR_URL . 'caffeinated/');
-define('EE_CAF_CORE', EE_CAFF_PATH . 'core' . DS);
-define('EE_CAF_LIBRARIES', EE_CAF_CORE . 'libraries' . DS);
-define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH . 'payment_methods' . DS);
+define('EE_CAF_URL', EE_PLUGIN_DIR_URL.'caffeinated/');
+define('EE_CAF_CORE', EE_CAFF_PATH.'core'.DS);
+define('EE_CAF_LIBRARIES', EE_CAF_CORE.'libraries'.DS);
+define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH.'payment_methods'.DS);
 
 
 
@@ -76,7 +76,7 @@ 
      */
     public function caf_helper_paths($paths)
     {
-        $paths[] = EE_CAF_CORE . 'helpers' . DS;
+        $paths[] = EE_CAF_CORE.'helpers'.DS;
         return $paths;
     }
 
@@ -98,10 +98,10 @@ 
         global $wpdb;
         //use same method of getting creator id as the version introducing the change
         $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table = $wpdb->prefix . "esp_price_type";
-        $price_table = $wpdb->prefix . "esp_price";
+        $price_type_table = $wpdb->prefix."esp_price_type";
+        $price_table = $wpdb->prefix."esp_price";
         if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
+            $SQL = 'SELECT COUNT(PRT_ID) FROM '.$price_type_table.' WHERE PBT_ID=4'; //include trashed price types
             $tax_price_type_count = $wpdb->get_var($SQL);
             if ($tax_price_type_count <= 1) {
                 $wpdb->insert(
@@ -115,11 +115,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ),
                     array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
+                        '%s', //PRT_name
+                        '%d', //PBT_id
+                        '%d', //PRT_is_percent
+                        '%d', //PRT_order
+                        '%d', //PRT_deleted
                         '%d', //PRT_wp_user
                     )
                 );
@@ -135,11 +135,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ),
                     array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
+                        '%s', //PRT_name
+                        '%d', //PBT_id
+                        '%d', //PRT_is_percent
+                        '%d', //PRT_order
+                        '%d', //PRT_deleted
                         '%d' //PRT_wp_user
                     )
                 );
@@ -159,15 +159,15 @@ 
                             'PRC_wp_user'    => $default_creator_id,
                         ),
                         array(
-                            '%d',//PRT_id
-                            '%f',//PRC_amount
-                            '%s',//PRC_name
-                            '%s',//PRC_desc
-                            '%d',//PRC_is_default
-                            '%d',//PRC_overrides
-                            '%d',//PRC_deleted
-                            '%d',//PRC_order
-                            '%d',//PRC_parent
+                            '%d', //PRT_id
+                            '%f', //PRC_amount
+                            '%s', //PRC_name
+                            '%s', //PRC_desc
+                            '%d', //PRC_is_default
+                            '%d', //PRC_overrides
+                            '%d', //PRC_deleted
+                            '%d', //PRC_order
+                            '%d', //PRC_parent
                             '%d' //PRC_wp_user
                         )
                     );
@@ -187,8 +187,8 @@ 
      */
     public function caffeinated_modules_to_register($modules_to_register = array())
     {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
+        if (is_readable(EE_CAFF_PATH.'modules')) {
+            $caffeinated_modules_to_register = glob(EE_CAFF_PATH.'modules'.DS.'*', GLOB_ONLYDIR);
             if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
                 $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
             }
@@ -268,7 +268,7 @@ 
      */
     public function caf_payment_methods($payment_method_paths)
     {
-        $caf_payment_methods_paths = glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $caf_payment_methods_paths = glob(EE_CAF_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         $payment_method_paths = array_merge($payment_method_paths, $caf_payment_methods_paths);
         return $payment_method_paths;
     }

core/EE_System.core.php

Indentation +1423 added lines, -1423 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,1428 +16,1428 @@ 
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @type  EE_Registry $Registry
-     * @access    protected
-     */
-    protected $registry;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Registry $Registry
-     * @return \EE_System
-     */
-    public static function instance(EE_Registry $Registry = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($Registry);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     *    sets hooks for running rest of system
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     *    starting EE Addons from any other point may lead to problems
-     *
-     * @access private
-     * @param  \EE_Registry $Registry
-     */
-    private function __construct(EE_Registry $Registry)
-    {
-        $this->registry = $Registry;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
-            3);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
-        // you wanna get going? I wanna get going... let's get going!
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        //load and setup EE_Capabilities
-        $this->registry->load_core('Capabilities');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if ( ! function_exists('json_basic_auth_handler')
-             && ! function_exists('json_basic_auth_error')
-             && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
-            )
-             && ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            //detect teh request type for that addon
-            $addon->detect_activation_or_upgrade();
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // load M-Mode class
-        $this->registry->load_core('Maintenance_Mode');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    protected function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required'));
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param null $espresso_db_update
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
-     *           from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if ( ! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if ( ! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            $addon->initialize_db_if_no_migrations_required();
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if ( ! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add == null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
-                'ee_espresso_activation', espresso_version());
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    protected function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if ( ! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
-                            ? '1970-01-01 00:00:00' : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->registry->load_core('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $this->registry->load_core('Config');
-        $this->registry->load_core('Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($this->registry->CFG->admin->use_full_logging) {
-            $this->registry->load_core('Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models);
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hookpoint
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
-        if ( ! empty($class_names)) {
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso');
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso');
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
-        add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->registry->load_core('PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if ( ! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->registry->load_core('Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->registry->load_core('Front_Controller', array(), false, true);
-        } else if ( ! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            EE_Registry::instance()->load_core('Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->registry->load_core('Session');
-        //		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-    }
-
-
-
-    /**
-     * set_hooks_for_shortcodes_modules_and_addons
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
-     * this happens at the very beginning of the wp_loaded hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function set_hooks_for_shortcodes_modules_and_addons()
-    {
-        //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if ( ! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if ( ! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if ( ! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
-    {
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-            || defined('DOING_AJAX')
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $menu_class = 'espresso_menu_item_class';
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        //because they're only defined in each of their respective constructors
-        //and this might be a frontend request, in which case they aren't available
-        $events_admin_url = admin_url("admin.php?page=espresso_events");
-        $reg_admin_url = admin_url("admin.php?page=espresso_registrations");
-        $extensions_admin_url = admin_url("admin.php?page=espresso_packages");
-        //Top Level
-        $admin_bar->add_menu(array(
-            'id'    => 'espresso-toolbar',
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                       . '</span>',
-            'href'  => $events_admin_url,
-            'meta'  => array(
-                'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
-            ),
-        ));
-        //Events
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Events', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('Events', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
-            //Events Add New
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-new',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('Add New', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Add New', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if (is_single() && (get_post_type() == 'espresso_events')) {
-            //Current post
-            global $post;
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
-            ) {
-                //Events Edit Current Event
-                $admin_bar->add_menu(array(
-                    'id'     => 'espresso-toolbar-events-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => __('Edit Event', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
-                        $events_admin_url),
-                    'meta'   => array(
-                        'title'  => __('Edit Event', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $menu_class,
-                    ),
-                ));
-            }
-        }
-        //Events View
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-view',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('View', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('View', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
-            //Events View All
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-all',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('All', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('All', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
-        ) {
-            //Events View Today
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-today',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
-        ) {
-            //Events View This Month
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-month',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Registrations', 'event_espresso'),
-                'href'   => $reg_admin_url,
-                'meta'   => array(
-                    'title'  => __('Registrations', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Completed
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Pending\
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-pending',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'     => 'default',
-                    'status'     => 'today',
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending Payment', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Pending
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-pending',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Not Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Cancelled
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Extensions & Services
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-extensions-and-services',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Extensions & Services', 'event_espresso'),
-                'href'   => $extensions_admin_url,
-                'meta'   => array(
-                    'title'  => __('Extensions & Services', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-    }
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-
-
-
-
-    /***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
-        if (apply_filters('FHEE_load_EE_System_scripts', true)) {
-            // jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
-            if (apply_filters('FHEE_load_jquery_validate', false)) {
-                // register jQuery Validate and additional methods
-                wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-                    array('jquery'), '1.15.0', true);
-                wp_register_script('jquery-validate-extra-methods',
-                    EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-                    array('jquery', 'jquery-validate'), '1.15.0', true);
-            }
-        }
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @type  EE_Registry $Registry
+	 * @access    protected
+	 */
+	protected $registry;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Registry $Registry
+	 * @return \EE_System
+	 */
+	public static function instance(EE_Registry $Registry = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($Registry);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *    sets hooks for running rest of system
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 *    starting EE Addons from any other point may lead to problems
+	 *
+	 * @access private
+	 * @param  \EE_Registry $Registry
+	 */
+	private function __construct(EE_Registry $Registry)
+	{
+		$this->registry = $Registry;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
+			3);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		//load and setup EE_Capabilities
+		$this->registry->load_core('Capabilities');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if ( ! function_exists('json_basic_auth_handler')
+			 && ! function_exists('json_basic_auth_error')
+			 && ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
+			)
+			 && ! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			//detect teh request type for that addon
+			$addon->detect_activation_or_upgrade();
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// load M-Mode class
+		$this->registry->load_core('Maintenance_Mode');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	protected function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required'));
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param null $espresso_db_update
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
+	 *           from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if ( ! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if ( ! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			$addon->initialize_db_if_no_migrations_required();
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if ( ! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add == null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
+				'ee_espresso_activation', espresso_version());
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	protected function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if ( ! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
+							? '1970-01-01 00:00:00' : $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->registry->load_core('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$this->registry->load_core('Config');
+		$this->registry->load_core('Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($this->registry->CFG->admin->use_full_logging) {
+			$this->registry->load_core('Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hookpoint
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
+		if ( ! empty($class_names)) {
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso');
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso');
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
+		add_action('admin_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 25);
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->registry->load_core('PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if ( ! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->registry->load_core('Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->registry->load_core('Front_Controller', array(), false, true);
+		} else if ( ! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			EE_Registry::instance()->load_core('Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->registry->load_core('Session');
+		//		add_action( 'wp_loaded', array( $this, 'set_hooks_for_shortcodes_modules_and_addons' ), 1 );
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+	}
+
+
+
+	/**
+	 * set_hooks_for_shortcodes_modules_and_addons
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
+	 * this happens at the very beginning of the wp_loaded hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_hooks_for_shortcodes_modules_and_addons()
+	{
+		//		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if ( ! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if ( ! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if ( ! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
+	{
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+			|| defined('DOING_AJAX')
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$menu_class = 'espresso_menu_item_class';
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		//because they're only defined in each of their respective constructors
+		//and this might be a frontend request, in which case they aren't available
+		$events_admin_url = admin_url("admin.php?page=espresso_events");
+		$reg_admin_url = admin_url("admin.php?page=espresso_registrations");
+		$extensions_admin_url = admin_url("admin.php?page=espresso_packages");
+		//Top Level
+		$admin_bar->add_menu(array(
+			'id'    => 'espresso-toolbar',
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+					   . '</span>',
+			'href'  => $events_admin_url,
+			'meta'  => array(
+				'title' => __('Event Espresso', 'event_espresso'),
+				'class' => $menu_class . 'first',
+			),
+		));
+		//Events
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Events', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('Events', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
+			//Events Add New
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-new',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('Add New', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
+				'meta'   => array(
+					'title'  => __('Add New', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if (is_single() && (get_post_type() == 'espresso_events')) {
+			//Current post
+			global $post;
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
+			) {
+				//Events Edit Current Event
+				$admin_bar->add_menu(array(
+					'id'     => 'espresso-toolbar-events-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => __('Edit Event', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
+						$events_admin_url),
+					'meta'   => array(
+						'title'  => __('Edit Event', 'event_espresso'),
+						'target' => '',
+						'class'  => $menu_class,
+					),
+				));
+			}
+		}
+		//Events View
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-view',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('View', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('View', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
+			//Events View All
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-all',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('All', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('All', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
+		) {
+			//Events View Today
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-today',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
+		) {
+			//Events View This Month
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-month',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Registrations', 'event_espresso'),
+				'href'   => $reg_admin_url,
+				'meta'   => array(
+					'title'  => __('Registrations', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Completed
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Pending\
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-pending',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'     => 'default',
+					'status'     => 'today',
+					'reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending Payment', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Pending
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-pending',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Not Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Cancelled
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Extensions & Services
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-extensions-and-services',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Extensions & Services', 'event_espresso'),
+				'href'   => $extensions_admin_url,
+				'meta'   => array(
+					'title'  => __('Extensions & Services', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+	}
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+
+
+
+
+	/***********************************************        WP_ENQUEUE_SCRIPTS HOOK         ***********************************************/
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// unlike other systems, EE_System_scripts loading is turned ON by default, but prior to the init hook, can be turned off via: add_filter( 'FHEE_load_EE_System_scripts', '__return_false' );
+		if (apply_filters('FHEE_load_EE_System_scripts', true)) {
+			// jquery_validate loading is turned OFF by default, but prior to the wp_enqueue_scripts hook, can be turned back on again via:  add_filter( 'FHEE_load_jquery_validate', '__return_true' );
+			if (apply_filters('FHEE_load_jquery_validate', false)) {
+				// register jQuery Validate and additional methods
+				wp_register_script('jquery-validate', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+					array('jquery'), '1.15.0', true);
+				wp_register_script('jquery-validate-extra-methods',
+					EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+					array('jquery', 'jquery-validate'), '1.15.0', true);
+			}
+		}
+	}
 
 
 

core/request_stack/EE_Request.core.php

Indentation +226 added lines, -226 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -15,231 +15,231 @@ 
 class EE_Request
 {
 
-    /**
-     * @access private
-     * @var    array $_get $_GET parameters
-     */
-    private $_get = array();
-
-    /**
-     * @access private
-     * @var    array $_post $_POST parameters
-     */
-    private $_post = array();
-
-    /**
-     * @access private
-     * @var    array $_cookie $_COOKIE parameters
-     */
-    private $_cookie = array();
-
-    /**
-     * @access private
-     * @var    array $_params $_REQUEST parameters
-     */
-    private $_params = array();
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var    boolean
-     * @access public
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var    boolean
-     * @access public
-     */
-    public $front_ajax = false;
-
-    /**
-     * IP address for request
-     *
-     * @var string $_ip_address
-     */
-    private $_ip_address = '';
-
-
-
-    /**
-     * class constructor
-     *
-     * @access    public
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     */
-    public function __construct($get, $post, $cookie)
-    {
-        // grab request vars
-        $this->_get = (array)$get;
-        $this->_post = (array)$post;
-        $this->_cookie = (array)$cookie;
-        $this->_params = array_merge($this->_get, $this->_post);
-        // AJAX ???
-        $this->ajax = defined('DOING_AJAX') ? true : false;
-        $this->front_ajax = $this->is_set('ee_front_ajax') && (int)$this->get('ee_front_ajax') === 1;
-        // grab user IP
-        $this->_ip_address = $this->_visitor_ip();
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function get_params()
-    {
-        return $this->_get;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function post_params()
-    {
-        return $this->_post;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function cookie_params()
-    {
-        return $this->_cookie;
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->_params;
-    }
-
-
-
-    /**
-     *    setter
-     *
-     * @access    public
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if (
-            $key !== 'ee'
-            || ($key === 'ee' && empty($this->_params['ee']))
-            || ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
-        ) {
-            $this->_params[$key] = $value;
-        }
-    }
-
-
-
-    /**
-     *    getter
-     *
-     * @access    public
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     */
-    public function get($key, $default = null)
-    {
-        return isset($this->_params[$key]) ? $this->_params[$key] : $default;
-    }
-
-
-
-    /**
-     *    check if param exists
-     *
-     * @access    public
-     * @param $key
-     * @return    boolean
-     */
-    public function is_set($key)
-    {
-        return isset($this->_params[$key]) ? true : false;
-    }
-
-
-
-    /**
-     *    remove param
-     *
-     * @access    public
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function un_set($key, $unset_from_global_too = false)
-    {
-        unset($this->_params[$key]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[$key]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ip_address()
-    {
-        return $this->_ip_address;
-    }
-
-
-
-    /**
-     * _visitor_ip
-     *    attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function _visitor_ip()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($_SERVER[$key])) {
-                foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
+	/**
+	 * @access private
+	 * @var    array $_get $_GET parameters
+	 */
+	private $_get = array();
+
+	/**
+	 * @access private
+	 * @var    array $_post $_POST parameters
+	 */
+	private $_post = array();
+
+	/**
+	 * @access private
+	 * @var    array $_cookie $_COOKIE parameters
+	 */
+	private $_cookie = array();
+
+	/**
+	 * @access private
+	 * @var    array $_params $_REQUEST parameters
+	 */
+	private $_params = array();
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var    boolean
+	 * @access public
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var    boolean
+	 * @access public
+	 */
+	public $front_ajax = false;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $_ip_address
+	 */
+	private $_ip_address = '';
+
+
+
+	/**
+	 * class constructor
+	 *
+	 * @access    public
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 */
+	public function __construct($get, $post, $cookie)
+	{
+		// grab request vars
+		$this->_get = (array)$get;
+		$this->_post = (array)$post;
+		$this->_cookie = (array)$cookie;
+		$this->_params = array_merge($this->_get, $this->_post);
+		// AJAX ???
+		$this->ajax = defined('DOING_AJAX') ? true : false;
+		$this->front_ajax = $this->is_set('ee_front_ajax') && (int)$this->get('ee_front_ajax') === 1;
+		// grab user IP
+		$this->_ip_address = $this->_visitor_ip();
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function get_params()
+	{
+		return $this->_get;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function post_params()
+	{
+		return $this->_post;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function cookie_params()
+	{
+		return $this->_cookie;
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->_params;
+	}
+
+
+
+	/**
+	 *    setter
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if (
+			$key !== 'ee'
+			|| ($key === 'ee' && empty($this->_params['ee']))
+			|| ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
+		) {
+			$this->_params[$key] = $value;
+		}
+	}
+
+
+
+	/**
+	 *    getter
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return isset($this->_params[$key]) ? $this->_params[$key] : $default;
+	}
+
+
+
+	/**
+	 *    check if param exists
+	 *
+	 * @access    public
+	 * @param $key
+	 * @return    boolean
+	 */
+	public function is_set($key)
+	{
+		return isset($this->_params[$key]) ? true : false;
+	}
+
+
+
+	/**
+	 *    remove param
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function un_set($key, $unset_from_global_too = false)
+	{
+		unset($this->_params[$key]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[$key]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ip_address()
+	{
+		return $this->_ip_address;
+	}
+
+
+
+	/**
+	 * _visitor_ip
+	 *    attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function _visitor_ip()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
 
 
 

Spacing +4 added lines, -4 removed lines

@@ -75,13 +75,13 @@
     public function __construct($get, $post, $cookie)
     {
         // grab request vars
-        $this->_get = (array)$get;
-        $this->_post = (array)$post;
-        $this->_cookie = (array)$cookie;
+        $this->_get = (array) $get;
+        $this->_post = (array) $post;
+        $this->_cookie = (array) $cookie;
         $this->_params = array_merge($this->_get, $this->_post);
         // AJAX ???
         $this->ajax = defined('DOING_AJAX') ? true : false;
-        $this->front_ajax = $this->is_set('ee_front_ajax') && (int)$this->get('ee_front_ajax') === 1;
+        $this->front_ajax = $this->is_set('ee_front_ajax') && (int) $this->get('ee_front_ajax') === 1;
         // grab user IP
         $this->_ip_address = $this->_visitor_ip();
     }

core/EE_Payment_Processor.core.php

Indentation +725 added lines, -725 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 EE_Registry::instance()->load_class('Processor_Base');
 
@@ -16,728 +16,728 @@ 
 class EE_Payment_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction appropriately.
-     * Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return \EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float)$amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()),//make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        } else {
-            EE_Error::add_error(
-                sprintf(
-                    __('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @throws EE_Error
-     * @return string
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if ( ! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Cannot get IPN URL for transaction with ID %d because it has no primary registration",
-                        "event_espresso"
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
-     *                                                 or is processed manually ( false like Mijireh )
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } else if ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                }
-            } else {
-                //that's actually pretty ok. The IPN just wasn't able
-                //to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        //that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
-            } else {
-                //we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log', __FILE__, __FUNCTION__, sprintf(
-                    __('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
-        }
-        return $return_data;
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @throws \EE_Error
-     * @return EE_Payment
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if (
-                    $payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            //global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws \EE_Error
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        //EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
-                } else {
-                    $available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
-                }
-            }
-        }
-        if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
-            EE_Error::add_attention(
-                sprintf(
-                    __('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_payment(EE_Registration $registration, EE_Payment $payment, $available_payment_amount = 0.00)
-    {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _apply_registration_payment(EE_Registration $registration, EE_Payment $payment, $payment_amount = 0.00)
-    {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_refund(EE_Registration $registration, EE_Payment $payment, $available_refund_amount = 0.00)
-    {
-        //EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float)abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float)$registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float)abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws \EE_Error
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true ? true : false;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if (
-            $IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            //ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect paypal standard, pro, express, and payflow.
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
-            //Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            //instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 1);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction appropriately.
+	 * Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return \EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float)$amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()),//make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		} else {
+			EE_Error::add_error(
+				sprintf(
+					__('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if ( ! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Cannot get IPN URL for transaction with ID %d because it has no primary registration",
+						"event_espresso"
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
+	 *                                                 or is processed manually ( false like Mijireh )
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} else if ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+				}
+			} else {
+				//that's actually pretty ok. The IPN just wasn't able
+				//to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						//that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
+			} else {
+				//we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log', __FILE__, __FUNCTION__, sprintf(
+					__('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
+		}
+		return $return_data;
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @throws \EE_Error
+	 * @return EE_Payment
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		$refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if (
+					$payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			//global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		//EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
+				} else {
+					$available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
+				}
+			}
+		}
+		if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
+			EE_Error::add_attention(
+				sprintf(
+					__('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payment(EE_Registration $registration, EE_Payment $payment, $available_payment_amount = 0.00)
+	{
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _apply_registration_payment(EE_Registration $registration, EE_Payment $payment, $payment_amount = 0.00)
+	{
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_refund(EE_Registration $registration, EE_Payment $payment, $available_refund_amount = 0.00)
+	{
+		//EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float)abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float)$registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float)abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws \EE_Error
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true ? true : false;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if (
+			$IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			//ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect paypal standard, pro, express, and payflow.
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
+			//Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			//instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 1);
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
         $update_txn = true,
         $cancel_url = ''
     ) {
-        if ((float)$amount < 0) {
+        if ((float) $amount < 0) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -108,7 +108,7 @@ 
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
             $payment = $payment_method->type_obj()->process_payment(
                 $transaction,
-                min($amount, $transaction->remaining()),//make sure we don't overcharge
+                min($amount, $transaction->remaining()), //make sure we don't overcharge
                 $billing_form,
                 $return_url,
                 add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
@@ -195,7 +195,7 @@ 
         $separate_IPN_request = true
     ) {
         EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
+        $_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
         EE_Processor_Base::set_IPN($separate_IPN_request);
         $obj_for_log = null;
         if ($transaction instanceof EE_Transaction) {
@@ -234,7 +234,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -271,7 +271,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -633,15 +633,15 @@ 
         //EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
         if ($registration->paid() > 0) {
             // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float)abs($available_refund_amount);
+            $available_refund_amount = (float) abs($available_refund_amount);
             // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float)$registration->paid());
+            $refund_amount = min($available_refund_amount, (float) $registration->paid());
             // update $available_payment_amount
             $available_refund_amount -= $refund_amount;
             //calculate and set new REG_paid
             $registration->set_paid($registration->paid() - $refund_amount);
             // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float)abs($refund_amount) * -1;
+            $refund_amount = (float) abs($refund_amount) * -1;
             // now save it
             $this->_apply_registration_payment($registration, $payment, $refund_amount);
         }

core/db_models/EEM_Base.model.php

Indentation +5538 added lines, -5538 removed lines

@@ -29,5546 +29,5546 @@
 abstract class EEM_Base extends EE_Base
 {
 
-    //admin posty
-    //basic -> grants access to mine -> if they don't have it, select none
-    //*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
-    //*_published -> grants access to published -> if they dont have it, select non-published
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
-    //frontend posty
-    //by default has access to published
-    //basic -> grants access to mine that arent published, and all published
-    //*_others ->grants access to others that arent private, all mine
-    //*_private -> grants full access
-    //frontend non-posty
-    //like admin posty
-    //category-y
-    //assign -> grants access to join-table
-    //(delete, edit)
-    //payment-method-y
-    //for each registered payment method,
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
-    /**
-     * 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 = array();
-
-    /**
-     * 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 = '';
-
-    /**
-     * 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 = array(
-        self::caps_read       => array(),
-        self::caps_read_admin => array(),
-        self::caps_edit       => array(),
-        self::caps_delete     => array(),
-    );
-
-    /**
-     * 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 = array();
-
-    /**
-     * 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 = array(
-        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 = array();
-
-    /**
-     * 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;
-
-    /**
-     * 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).
-     *
-     * @var boolean
-     */
-    protected $_wp_core_model = false;
-
-    /**
-     *    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 = array(
-        '='           => '=',
-        '<='          => '<=',
-        '<'           => '<',
-        '>='          => '>=',
-        '>'           => '>',
-        '!='          => '!=',
-        '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 = array('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 = array('BETWEEN');
-
-    /**
-     * 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 = array('IS NOT NULL', 'IS NULL');
-
-    /**
-     * Allowed values for $query_params['order'] for ordering in queries
-     *
-     * @var array
-     */
-    protected $_allowed_order_values = array('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 = array('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 = array(
-        0,
-        'limit',
-        'order_by',
-        'group_by',
-        'having',
-        'force_join',
-        'order',
-        'on_join_limit',
-        'default_where_conditions',
-        'caps',
-    );
-
-    /**
-     * All the data types that can be used in $wpdb->prepare statements.
-     *
-     * @var array
-     */
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
-
-    /**
-     *    EE_Registry Object
-     *
-     * @var    object
-     * @access    protected
-     */
-    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 so those selections can be used in WHERE, GROUP_BY, etc.
-     *
-     * @var array
-     */
-    protected $_custom_selections = array();
-
-    /**
-     * 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;
-
-    /**
-     * 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;
-
-
-
-    /**
-     * 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(
-                    __('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 = 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) {
-                /** @var $table_obj 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 = 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(__("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 = 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) {
-            /** @var $index_obj EE_Index */
-            $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 ($this->_cap_restriction_generators !== false) {
-            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 ($this->_cap_restriction_generators !== false) {
-            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(
-                            __('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');
-    }
-
-
-
-    /**
-     * Generates the cap restrictions for the given context, or if they were
-     * already generated just gets what's cached
-     *
-     * @param string $context one of EEM_Base::valid_cap_contexts()
-     * @return EE_Default_Where_Conditions[]
-     */
-    protected function _generate_cap_restrictions($context)
-    {
-        if (isset($this->_cap_restriction_generators[$context])
-            && $this->_cap_restriction_generators[$context]
-               instanceof
-               EE_Restriction_Generator_Base
-        ) {
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
-        } else {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * 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;
-    }
-
-
-
-    /**
-     *        This function is a singleton method used to instantiate the Espresso_model object
-     *
-     * @access public
-     * @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)
-     * @return static (as in the concrete child class)
-     */
-    public static function instance($timezone = null)
-    {
-        // check if instance of Espresso_model already exists
-        if ( ! static::$_instance instanceof static) {
-            // instantiate Espresso_model
-            static::$_instance = new static($timezone);
-        }
-        //we might have a timezone set, let set_timezone decide what to do with it
-        static::$_instance->set_timezone($timezone);
-        // Espresso_model object
-        return static::$_instance;
-    }
-
-
-
-    /**
-     * resets the model and returns it
-     *
-     * @param null | string $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)
-     */
-    public static function reset($timezone = null)
-    {
-        if (static::$_instance instanceof EEM_Base) {
-            //let's try to NOT swap out the current instance for a new one
-            //because if someone has a reference to it, we can't remove their reference
-            //so it's best to keep using the same reference, but change the original object
-            //reset all its properties to their original values as defined in the class
-            $r = new ReflectionClass(get_class(static::$_instance));
-            $static_properties = $r->getStaticProperties();
-            foreach ($r->getDefaultProperties() 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
-            static::$_instance->__construct($timezone);
-            return self::instance();
-        }
-        return null;
-    }
-
-
-
-    /**
-     * 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
-     */
-    public function status_array($translated = false)
-    {
-        if ( ! array_key_exists('Status', $this->_model_relations)) {
-            return array();
-        }
-        $model_name = $this->get_this_model_name();
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
-        $status_array = 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             {
-     * @var array $0 (where) array {
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
-     *                                        conditions based on related models (and even
-     *                                        models-related-to-related-models) prepend the model's name onto the field
-     *                                        name. Eg,
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE Venue_CPT.ID = 12 Notice that automatically
-     *                                        took care of joining Events to Venues (even when each of those models actually consisted of two tables). Also, you may chain the model relations together. Eg instead of just having
-     *                                        "Venue.VNU_ID", you could have
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
-     *                                        events are related to Registrations, which are related to Attendees). You
-     *                                        can take it even further with
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
-     *                                        (from the default of '='), change the value to an numerically-indexed
-     *                                        array, where the first item in the list is the operator. eg: array(
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN (followed by an array with exactly 2 date strings), IS NULL, and IS NOT NULL Values can be a string, int, or float. They can
-     *                                        also be arrays IFF the operator is IN. Also, values can actually be field names. To indicate the value is a field, simply provide a third array item (true) to the operator-value array like so:
-     *                                        eg: array( 'DTT_reg_limit' => array('>', 'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold" Note: you can also use related model field names like you would any other field
-     *                                        name. eg: array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default
-     *                                        all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp = 345678912...". Also, to negate an entire set of conditions, use 'NOT' as an array key. eg: array('NOT'=>array('TXN_total' =>
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND TXN_paid =23) Note: the 'glue' used to join each condition will continue to be what you last specified. IE, "AND"s by default,
-     *                                        but if you had previously specified to use ORs to join, ORs will continue to be used. So, if you specify to use an "OR" to join conditions, it will continue to "stick" until you specify an AND.
-     *                                        eg array('OR'=>array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >> "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg: array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes
-     *                                        SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to
-     *                                        place two or more where conditions applying to the same field. eg:
-     *                                        array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus
-     *                                        removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*'
-     *                                        character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the
-     *                                        previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND PAY_timestamp != 1241234123" This can be applied to condition operators too, eg:
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL "...LIMIT 23", "...LIMIT 25,50",
-     *                                        and "...LIMIT 23,42" respectively. Remember when you provide two numbers for the limit, the 1st number is
-     *                                        the OFFSET, the 2nd is the LIMIT
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the following format array('on_join_limit'
-     *                                        => array( 'table_alias', array(1,2) ) ).
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
-     *                                        values are either 'ASC' or 'DESC'. 'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date DESC..." respectively. Like the
-     *                                        'where' conditions, these fields can be on related models. Eg
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is perfectly valid from any model related
-     *                                        to 'Registration' (like Event, Attendee, Price, Datetime, etc.)
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
-     *                                        'order' specifies whether to order the field specified in 'order_by' in ascending or descending order.
-     *                                        Acceptable values are 'ASC' or 'DESC'. If, 'order_by' isn't used, but 'order' is, then it is assumed you
-     *                                        want to order by the primary key. Eg,
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC'); //(will join
-     *                                        with the Datetime model's table(s) and order by its field DTT_EVT_start) or
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make SQL "SELECT * FROM
-     *                                        wp_esp_registration ORDER BY REG_ID ASC"
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
-     *                                        'group_by'=>'VNU_ID', or 'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note: if no
-     *                                        $group_by is specified, and a limit is set, automatically groups by the model's primary key (or combined
-     *                                        primary keys). This avoids some weirdness that results when using limits, tons of joins, and no group by,
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped results)
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
-     *                                        array where values are models to be joined in the query.Eg array('Attendee','Payment','Datetime'). You may
-     *                                        join with transient models using period, eg "Registration.Transaction.Payment". You will probably only want
-     *                                        to do this in hopes of increasing efficiency, as related models which belongs to the current model
-     *                                        (ie, the current model has a foreign key to them, like how Registration
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually soft-deleted objects are
-     *                                        filtered-out if you want to include them, set this query param to 'none'. If you want to ONLY disable THIS
-     *                                        model's default where conditions set it to 'other_models_only'. If you only want this model's default where
-     *                                        conditions added to the query, use 'this_model_only'. If you want to use all default where conditions
-     *                                        (default), set to 'all'.
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return everything? Or should we only show
-     *                                        the current user items they should be able to view on the frontend, backend, edit, or delete? can be set to
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
-     *                                        }
-     * @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()and make it public again. 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
-     */
-    public function get_all($query_params = array())
-    {
-        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, ARRAY_A, null));
-    }
-
-
-
-    /**
-     * Modifies the query parameters so we only get back model objects
-     * that "belong" to the current user
-     *
-     * @param array $query_params @see EEM_Base::get_all()
-     * @return array like EEM_Base::get_all
-     */
-    public function alter_query_params_to_only_include_mine($query_params = array())
-    {
-        $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
-     */
-    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;
-        } else {
-            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      like EEM_Base::get_all's $query_params
-     * @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
-     */
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
-    {
-        // remember the custom selections, if any, and type cast as array
-        // (unless $columns_to_select is an object, then just set as an empty array)
-        // Note: (array) 'some string' === array( 'some string' )
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions = $columns_to_select !== null
-            ? $this->_construct_select_from_input($columns_to_select)
-            : $this->_construct_default_select_sql($model_query_info);
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
-    }
-
-
-
-    /**
-     * Gets an array of rows from the database just like $wpdb->get_results would,
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
-     * take care of joins, field preparation etc.
-     *
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
-     * @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 = array(), $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
-     * @throws EE_Error
-     * @return string
-     */
-    private function _construct_select_from_input($columns_to_select)
-    {
-        if (is_array($columns_to_select)) {
-            $select_sql_array = 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(
-                            __(
-                                "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)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                "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
-     */
-    public function get_one_by_ID($id)
-    {
-        if ($this->get_from_entity_map($id)) {
-            return $this->get_from_entity_map($id);
-        }
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'minimum')
-            )
-        );
-    }
-
-
-
-    /**
-     * 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 EEM_Base::get_all
-     * @throws \EE_Error
-     */
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
-    {
-        if ( ! isset($query_params[0])) {
-            $query_params[0] = array();
-        }
-        $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 = array())
-    {
-        if ( ! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        $query_params['limit'] = 1;
-        $items = $this->get_all($query_params);
-        if (empty($items)) {
-            return null;
-        } else {
-            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 = array(),
-        $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 = array(),
-        $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 = array(),
-        $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 = array(),
-        $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 = array(),
-        $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(__('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(__('There was an error with the query.', 'event_espresso'));
-                return array();
-            }
-        }
-        if ( ! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        //let's add the where query param for consecutive look up.
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
-        $query_params['limit'] = $limit;
-        //set direction
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
-        $query_params['order_by'] = $operand === '>'
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
-            : array($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);
-        } else {
-            //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.
-     *
-     * @since 4.6.x
-     * @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).
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
-     * @return array formats in an array with the date format first, and the time format last.
-     */
-    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(__('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 array($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())
-     *
-     * @since 4.6.x
-     * @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.
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
-     *                                 exception is triggered.
-     */
-    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]);
-                break;
-            case 'date' :
-                return $DateTime->format($formats[0]);
-                break;
-            default :
-                return $DateTime->format(implode(' ', $formats));
-                break;
-        }
-    }
-
-
-
-    /**
-     * 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));
-        return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
-    }
-
-
-
-    /**
-     * 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            very much like EEM_Base::get_all's $query_params
-     *                                         in client code into what's expected to be stored on each field. 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
-     */
-    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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        /**
-         * 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 EEM_Base::get_all()
-         */
-        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 EEM_Base::get_all()
-         */
-        $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 = array();
-                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 = array(
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
-                    'limit'                    => count($model_objs_affected_ids),
-                    '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', array($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 EEM_Base::get_all()
-         * @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 EEM_Base::get_all()
-     * @param string $field_to_select
-     * @return array just like $wpdb->get_col()
-     * @throws \EE_Error
-     */
-    public function get_col($query_params = array(), $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 {
-            //no primary key, just grab the first column
-            $field = reset($this->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', array($SQL));
-    }
-
-
-
-    /**
-     * Returns a single column value for a single row from the database
-     *
-     * @param array  $query_params    @see EEM_Base::get_all()
-     * @param string $field_to_select @see EEM_Base::get_col()
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_var($query_params = array(), $field_to_select = null)
-    {
-        $query_params['limit'] = 1;
-        $col = $this->get_col($query_params, $field_to_select);
-        if ( ! empty($col)) {
-            return reset($col);
-        } else {
-            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
-     *
-     * @global      $wpdb
-     * @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
-     */
-    public function _construct_update_sql($fields_n_values)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $cols_n_values = array();
-        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
-     * @return boolean whether the row got deleted or not
-     * @throws \EE_Error
-     */
-    public function delete_permanently_by_ID($id)
-    {
-        return $this->delete_permanently(
-            array(
-                array($this->get_primary_key_field()->get_name() => $id),
-                'limit' => 1,
-            )
-        );
-    }
-
-
-
-    /**
-     * 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
-     * @return boolean whether the row got deleted or not
-     * @throws \EE_Error
-     */
-    public function delete_by_ID($id)
-    {
-        return $this->delete(
-            array(
-                array($this->get_primary_key_field()->get_name() => $id),
-                'limit' => 1,
-            )
-        );
-    }
-
-
-
-    /**
-     * 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.
-     *
-     * @see EEM_Base::delete_permanently
-     * @param array   $query_params
-     * @param boolean $allow_blocking
-     * @return int how many rows got deleted
-     * @throws \EE_Error
-     */
-    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   very much like EEM_Base::get_all's $query_params
-     * @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
-     */
-    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 EEM_Base::get_all()
-         * @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);
-        $deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
-        if ($deletion_where) {
-            //echo "objects for deletion:";var_dump($objects_for_deletion);
-            $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;
-            //		/echo "delete sql:$SQL";
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
-        } else {
-            $rows_deleted = 0;
-        }
-        //and lastly make sure those items are removed from the entity map; if they could be put into it at all
-        if ($this->has_primary_key_field()) {
-            foreach ($items_for_deletion as $item_for_deletion_row) {
-                $pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
-                }
-            }
-        }
-        /**
-         * 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 EEM_Base::get_all()
-         * @param int      $rows_deleted
-         */
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
-        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
-     */
-    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, array(
-                        array(
-                            $ignored_model->get_primary_key_field()->get_name() => array(
-                                '!=',
-                                $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;
-    }
-
-
-
-    /**
-     * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
-     * well.
-     *
-     * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
-     * @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
-     * @throws EE_Error
-     * @return string    everything that comes after the WHERE statement.
-     */
-    protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
-    {
-        if ($this->has_primary_key_field()) {
-            $primary_table = $this->_get_main_table();
-            $other_tables = $this->_get_other_tables();
-            $deletes = $query = array();
-            foreach ($objects_for_deletion as $delete_object) {
-                //before we mark this object for deletion,
-                //make sure there's no related objects blocking its deletion (if we're checking)
-                if (
-                    $allow_blocking
-                    && $this->delete_is_blocked_by_related_models(
-                        $delete_object[$primary_table->get_fully_qualified_pk_column()]
-                    )
-                ) {
-                    continue;
-                }
-                //primary table deletes
-                if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
-                    $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
-                }
-                //other tables
-                if ( ! empty($other_tables)) {
-                    foreach ($other_tables as $ot) {
-                        //first check if we've got the foreign key column here.
-                        if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
-                        }
-                        // wait! it's entirely possible that we'll have a the primary key
-                        // for this table in here, if it's a foreign key for one of the other secondary tables
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
-                        }
-                        // finally, it is possible that the fk for this table is found
-                        // in the fully qualified pk column for the fk table, so let's see if that's there!
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
-                        }
-                    }
-                }
-            }
-            //we should have deletes now, so let's just go through and setup the where statement
-            foreach ($deletes as $column => $values) {
-                //make sure we have unique $values;
-                $values = array_unique($values);
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
-            }
-            return ! empty($query) ? implode(' AND ', $query) : '';
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
-            $ways_to_identify_a_row = array();
-            $fields = $this->get_combined_primary_key_fields();
-            //note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
-            foreach ($objects_for_deletion as $delete_object) {
-                $values_for_each_cpk_for_a_row = array();
-                foreach ($fields as $cpk_field) {
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
-                        $values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
-                                                           . "="
-                                                           . $delete_object[$cpk_field->get_qualified_column()];
-                    }
-                }
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
-            }
-            return implode(" OR ", $ways_to_identify_a_row);
-        } else {
-            //so there's no primary key and no combined key...
-            //sorry, can't help you
-            throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
-                "event_espresso"), get_class($this)));
-        }
-    }
-
-
-
-    /**
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
-     * 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   like EEM_Base::get_all's
-     * @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 = array(), $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 = array();
-                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', array($SQL));
-    }
-
-
-
-    /**
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @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', array($SQL));
-        $data_type = $field_obj->get_wpdb_data_type();
-        if ($data_type === '%d' || $data_type === '%s') {
-            return (float)$return_value;
-        } else {//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
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     * @return mixed
-     */
-    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(__("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(__('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(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
-            } elseif ($result === false) {
-                throw new EE_Error(sprintf(__('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(
-                    __('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(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;
-                    break;
-            }
-            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(
-            __('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,
-            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(
-            __('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,
-            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 $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 = array()
-    ) {
-        $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
-     * @return boolean of success
-     * @throws \EE_Error
-     * @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.
-     */
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        $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 = array())
-    {
-        $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 like EEM_Base::get_all
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    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
-     */
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
-    {
-        $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
-     */
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
-    {
-        $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   like EEM_Base::get_all's
-     * @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 = array(),
-        $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'] = '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 like EEM_Base::get_all's
-     * @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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        //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'] = '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     like EEM_Base::get_all's
-     * @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);
-        } else {
-            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(__("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 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;
-        } else {
-            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(array($uniqueness_where_params))) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            "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
-     * @throws EE_Error
-     * @return EE_Base_Class|array
-     */
-    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(
-                    __(
-                        "%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 = array();
-        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 array();
-        } else {
-            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(array('default_where_conditions' => 'none', array($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
-     * @throws EE_Error
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
-     * @return int ID of new row inserted, or FALSE on failure
-     */
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
-    {
-        global $wpdb;
-        $insertion_col_n_values = array();
-        $format_for_insertion = array();
-        $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',
-            array($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;
-            } else {
-                //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()];
-            }
-        } else {
-            //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)
-    {
-        //if this field doesn't allow nullable, don't allow it
-        if ( ! $field_obj->is_nullable()
-             && (
-                 ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
-        ) {
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
-        }
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_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 && $field instanceof EE_Model_Field_Base) {
-            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"
-                case self::prepared_by_model_object:
-                    $value = $field->prepare_for_use_in_db($value);
-                case self::prepared_for_use_in_db:
-                    //leave the value alone
-            }
-            return $value;
-        } else {
-            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(__('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 = array();
-        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 like EEM_Base::get_all's $query_parameters['where']
-     * @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'
-            );
-        }
-        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 like EEM_Base::get_all's $query_params[0] or
-     *                                                      $query_params['having']
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @return \EE_Model_Query_Info_Carrier
-     */
-    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(__("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));
-                    } else {
-                        $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(__("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 like EEM_Base::get_all's $query_params[0] or
-     *                                                      $query_params['having']
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @throws EE_Error
-     * @return \EE_Model_Query_Info_Carrier
-     */
-    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(__("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 $query_params (an array like whats passed to EEM_Base::get_all)
-     * 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
-     * @throws EE_Error
-     * @return EE_Model_Query_Info_Carrier
-     */
-    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(
-                    __(
-                        '$query_params should be an array, you passed a variable of type %s',
-                        'event_espresso'
-                    ),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = array();
-        }
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
-        //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] = $where_query_params = array_replace_recursive(
-                $where_query_params,
-                $this->caps_where_conditions(
-                    $query_params['caps']
-                )
-            );
-        }
-        $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 ($where_query_params as $key => $value) {
-            if (is_int($key)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "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 = 'all';
-        }
-        $where_query_params = array_merge(
-            $this->_get_default_where_conditions_for_models_in_query(
-                $query_object,
-                $use_default_where_conditions,
-                $where_query_params
-            ),
-            $where_query_params
-        );
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
-        // 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(
-                        __(
-                            "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(
-                            __(
-                                "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 = 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 = 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(
-                        __(
-                            "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 like EEM_Base::get_all() 's $query_params[0]
-     * @throws \EE_Error
-     */
-    public function caps_where_conditions($context = self::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        $cap_where_conditions = array();
-        $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;
-        } else {
-            throw new EE_Error(sprintf(__("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           like EEM_Base::get_all's $query_params[0]
-     * @throws EE_Error
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
-     */
-    private function _get_default_where_conditions_for_models_in_query(
-        EE_Model_Query_Info_Carrier $query_info_carrier,
-        $use_default_where_conditions = 'all',
-        $where_query_params = array()
-    ) {
-        $allowed_used_default_where_conditions_values = array(
-            'all',
-            'this_model_only',
-            'other_models_only',
-            'minimum',
-            'none',
-        );
-        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
-            throw new EE_Error(sprintf(__("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 = array();
-        if ($use_default_where_conditions === 'all' || $use_default_where_conditions === 'this_model_only') {
-            $universal_query_params = $this->_get_default_where_conditions();
-        } else if ($use_default_where_conditions === 'minimum') {
-            $universal_query_params = $this->_get_minimum_where_conditions();
-        }
-        if (in_array($use_default_where_conditions, array('all', 'other_models_only'))) {
-            foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
-                $related_model = $this->get_related_model_obj($model_name);
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
-                $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;
-    }
-
-
-
-    /**
-     * 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 like EEM_Base::get_all's $query_params[0]
-     * @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 = array();
-        $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()] = array('IS NULL');
-            }/*else{
+	//admin posty
+	//basic -> grants access to mine -> if they don't have it, select none
+	//*_others -> grants access to others that arent private, and all mine -> if they don't have it, select mine
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
+	//*_published -> grants access to published -> if they dont have it, select non-published
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
+	//frontend posty
+	//by default has access to published
+	//basic -> grants access to mine that arent published, and all published
+	//*_others ->grants access to others that arent private, all mine
+	//*_private -> grants full access
+	//frontend non-posty
+	//like admin posty
+	//category-y
+	//assign -> grants access to join-table
+	//(delete, edit)
+	//payment-method-y
+	//for each registered payment method,
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
+	/**
+	 * 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 = array();
+
+	/**
+	 * 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 = '';
+
+	/**
+	 * 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 = array(
+		self::caps_read       => array(),
+		self::caps_read_admin => array(),
+		self::caps_edit       => array(),
+		self::caps_delete     => array(),
+	);
+
+	/**
+	 * 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 = array();
+
+	/**
+	 * 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 = array(
+		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 = array();
+
+	/**
+	 * 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;
+
+	/**
+	 * 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).
+	 *
+	 * @var boolean
+	 */
+	protected $_wp_core_model = false;
+
+	/**
+	 *    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 = array(
+		'='           => '=',
+		'<='          => '<=',
+		'<'           => '<',
+		'>='          => '>=',
+		'>'           => '>',
+		'!='          => '!=',
+		'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 = array('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 = array('BETWEEN');
+
+	/**
+	 * 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 = array('IS NOT NULL', 'IS NULL');
+
+	/**
+	 * Allowed values for $query_params['order'] for ordering in queries
+	 *
+	 * @var array
+	 */
+	protected $_allowed_order_values = array('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 = array('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 = array(
+		0,
+		'limit',
+		'order_by',
+		'group_by',
+		'having',
+		'force_join',
+		'order',
+		'on_join_limit',
+		'default_where_conditions',
+		'caps',
+	);
+
+	/**
+	 * All the data types that can be used in $wpdb->prepare statements.
+	 *
+	 * @var array
+	 */
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
+
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var    object
+	 * @access    protected
+	 */
+	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 so those selections can be used in WHERE, GROUP_BY, etc.
+	 *
+	 * @var array
+	 */
+	protected $_custom_selections = array();
+
+	/**
+	 * 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;
+
+	/**
+	 * 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;
+
+
+
+	/**
+	 * 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(
+					__('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 = 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) {
+				/** @var $table_obj 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 = 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(__("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 = 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) {
+			/** @var $index_obj EE_Index */
+			$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 ($this->_cap_restriction_generators !== false) {
+			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 ($this->_cap_restriction_generators !== false) {
+			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(
+							__('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');
+	}
+
+
+
+	/**
+	 * Generates the cap restrictions for the given context, or if they were
+	 * already generated just gets what's cached
+	 *
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
+	 * @return EE_Default_Where_Conditions[]
+	 */
+	protected function _generate_cap_restrictions($context)
+	{
+		if (isset($this->_cap_restriction_generators[$context])
+			&& $this->_cap_restriction_generators[$context]
+			   instanceof
+			   EE_Restriction_Generator_Base
+		) {
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
+		} else {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * 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;
+	}
+
+
+
+	/**
+	 *        This function is a singleton method used to instantiate the Espresso_model object
+	 *
+	 * @access public
+	 * @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)
+	 * @return static (as in the concrete child class)
+	 */
+	public static function instance($timezone = null)
+	{
+		// check if instance of Espresso_model already exists
+		if ( ! static::$_instance instanceof static) {
+			// instantiate Espresso_model
+			static::$_instance = new static($timezone);
+		}
+		//we might have a timezone set, let set_timezone decide what to do with it
+		static::$_instance->set_timezone($timezone);
+		// Espresso_model object
+		return static::$_instance;
+	}
+
+
+
+	/**
+	 * resets the model and returns it
+	 *
+	 * @param null | string $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)
+	 */
+	public static function reset($timezone = null)
+	{
+		if (static::$_instance instanceof EEM_Base) {
+			//let's try to NOT swap out the current instance for a new one
+			//because if someone has a reference to it, we can't remove their reference
+			//so it's best to keep using the same reference, but change the original object
+			//reset all its properties to their original values as defined in the class
+			$r = new ReflectionClass(get_class(static::$_instance));
+			$static_properties = $r->getStaticProperties();
+			foreach ($r->getDefaultProperties() 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
+			static::$_instance->__construct($timezone);
+			return self::instance();
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	public function status_array($translated = false)
+	{
+		if ( ! array_key_exists('Status', $this->_model_relations)) {
+			return array();
+		}
+		$model_name = $this->get_this_model_name();
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
+		$status_array = 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             {
+	 * @var array $0 (where) array {
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
+	 *                                        conditions based on related models (and even
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
+	 *                                        name. Eg,
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE Venue_CPT.ID = 12 Notice that automatically
+	 *                                        took care of joining Events to Venues (even when each of those models actually consisted of two tables). Also, you may chain the model relations together. Eg instead of just having
+	 *                                        "Venue.VNU_ID", you could have
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
+	 *                                        events are related to Registrations, which are related to Attendees). You
+	 *                                        can take it even further with
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
+	 *                                        (from the default of '='), change the value to an numerically-indexed
+	 *                                        array, where the first item in the list is the operator. eg: array(
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN (followed by an array with exactly 2 date strings), IS NULL, and IS NOT NULL Values can be a string, int, or float. They can
+	 *                                        also be arrays IFF the operator is IN. Also, values can actually be field names. To indicate the value is a field, simply provide a third array item (true) to the operator-value array like so:
+	 *                                        eg: array( 'DTT_reg_limit' => array('>', 'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold" Note: you can also use related model field names like you would any other field
+	 *                                        name. eg: array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default
+	 *                                        all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp = 345678912...". Also, to negate an entire set of conditions, use 'NOT' as an array key. eg: array('NOT'=>array('TXN_total' =>
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND TXN_paid =23) Note: the 'glue' used to join each condition will continue to be what you last specified. IE, "AND"s by default,
+	 *                                        but if you had previously specified to use ORs to join, ORs will continue to be used. So, if you specify to use an "OR" to join conditions, it will continue to "stick" until you specify an AND.
+	 *                                        eg array('OR'=>array('NOT'=>array('TXN_total' => 50, 'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >> "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg: array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes
+	 *                                        SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to
+	 *                                        place two or more where conditions applying to the same field. eg:
+	 *                                        array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus
+	 *                                        removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*'
+	 *                                        character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the
+	 *                                        previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND PAY_timestamp != 1241234123" This can be applied to condition operators too, eg:
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL "...LIMIT 23", "...LIMIT 25,50",
+	 *                                        and "...LIMIT 23,42" respectively. Remember when you provide two numbers for the limit, the 1st number is
+	 *                                        the OFFSET, the 2nd is the LIMIT
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the following format array('on_join_limit'
+	 *                                        => array( 'table_alias', array(1,2) ) ).
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
+	 *                                        values are either 'ASC' or 'DESC'. 'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date DESC..." respectively. Like the
+	 *                                        'where' conditions, these fields can be on related models. Eg
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is perfectly valid from any model related
+	 *                                        to 'Registration' (like Event, Attendee, Price, Datetime, etc.)
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in ascending or descending order.
+	 *                                        Acceptable values are 'ASC' or 'DESC'. If, 'order_by' isn't used, but 'order' is, then it is assumed you
+	 *                                        want to order by the primary key. Eg,
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC'); //(will join
+	 *                                        with the Datetime model's table(s) and order by its field DTT_EVT_start) or
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make SQL "SELECT * FROM
+	 *                                        wp_esp_registration ORDER BY REG_ID ASC"
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
+	 *                                        'group_by'=>'VNU_ID', or 'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note: if no
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the model's primary key (or combined
+	 *                                        primary keys). This avoids some weirdness that results when using limits, tons of joins, and no group by,
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped results)
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
+	 *                                        array where values are models to be joined in the query.Eg array('Attendee','Payment','Datetime'). You may
+	 *                                        join with transient models using period, eg "Registration.Transaction.Payment". You will probably only want
+	 *                                        to do this in hopes of increasing efficiency, as related models which belongs to the current model
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually soft-deleted objects are
+	 *                                        filtered-out if you want to include them, set this query param to 'none'. If you want to ONLY disable THIS
+	 *                                        model's default where conditions set it to 'other_models_only'. If you only want this model's default where
+	 *                                        conditions added to the query, use 'this_model_only'. If you want to use all default where conditions
+	 *                                        (default), set to 'all'.
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return everything? Or should we only show
+	 *                                        the current user items they should be able to view on the frontend, backend, edit, or delete? can be set to
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
+	 *                                        }
+	 * @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()and make it public again. 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
+	 */
+	public function get_all($query_params = array())
+	{
+		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, ARRAY_A, null));
+	}
+
+
+
+	/**
+	 * Modifies the query parameters so we only get back model objects
+	 * that "belong" to the current user
+	 *
+	 * @param array $query_params @see EEM_Base::get_all()
+	 * @return array like EEM_Base::get_all
+	 */
+	public function alter_query_params_to_only_include_mine($query_params = array())
+	{
+		$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
+	 */
+	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;
+		} else {
+			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      like EEM_Base::get_all's $query_params
+	 * @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
+	 */
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
+	{
+		// remember the custom selections, if any, and type cast as array
+		// (unless $columns_to_select is an object, then just set as an empty array)
+		// Note: (array) 'some string' === array( 'some string' )
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions = $columns_to_select !== null
+			? $this->_construct_select_from_input($columns_to_select)
+			: $this->_construct_default_select_sql($model_query_info);
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
+	}
+
+
+
+	/**
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
+	 * take care of joins, field preparation etc.
+	 *
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
+	 * @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 = array(), $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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	private function _construct_select_from_input($columns_to_select)
+	{
+		if (is_array($columns_to_select)) {
+			$select_sql_array = 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(
+							__(
+								"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)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								"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
+	 */
+	public function get_one_by_ID($id)
+	{
+		if ($this->get_from_entity_map($id)) {
+			return $this->get_from_entity_map($id);
+		}
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'minimum')
+			)
+		);
+	}
+
+
+
+	/**
+	 * 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 EEM_Base::get_all
+	 * @throws \EE_Error
+	 */
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
+	{
+		if ( ! isset($query_params[0])) {
+			$query_params[0] = array();
+		}
+		$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 = array())
+	{
+		if ( ! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		$query_params['limit'] = 1;
+		$items = $this->get_all($query_params);
+		if (empty($items)) {
+			return null;
+		} else {
+			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 = array(),
+		$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 = array(),
+		$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 = array(),
+		$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 = array(),
+		$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 = array(),
+		$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(__('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(__('There was an error with the query.', 'event_espresso'));
+				return array();
+			}
+		}
+		if ( ! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		//let's add the where query param for consecutive look up.
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
+		$query_params['limit'] = $limit;
+		//set direction
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
+		$query_params['order_by'] = $operand === '>'
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
+			: array($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);
+		} else {
+			//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.
+	 *
+	 * @since 4.6.x
+	 * @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).
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
+	 * @return array formats in an array with the date format first, and the time format last.
+	 */
+	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(__('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 array($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())
+	 *
+	 * @since 4.6.x
+	 * @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.
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
+	 *                                 exception is triggered.
+	 */
+	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]);
+				break;
+			case 'date' :
+				return $DateTime->format($formats[0]);
+				break;
+			default :
+				return $DateTime->format(implode(' ', $formats));
+				break;
+		}
+	}
+
+
+
+	/**
+	 * 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));
+		return $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone));
+	}
+
+
+
+	/**
+	 * 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            very much like EEM_Base::get_all's $query_params
+	 *                                         in client code into what's expected to be stored on each field. 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
+	 */
+	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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		/**
+		 * 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 EEM_Base::get_all()
+		 */
+		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 EEM_Base::get_all()
+		 */
+		$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 = array();
+				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 = array(
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
+					'limit'                    => count($model_objs_affected_ids),
+					'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', array($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 EEM_Base::get_all()
+		 * @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 EEM_Base::get_all()
+	 * @param string $field_to_select
+	 * @return array just like $wpdb->get_col()
+	 * @throws \EE_Error
+	 */
+	public function get_col($query_params = array(), $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 {
+			//no primary key, just grab the first column
+			$field = reset($this->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', array($SQL));
+	}
+
+
+
+	/**
+	 * Returns a single column value for a single row from the database
+	 *
+	 * @param array  $query_params    @see EEM_Base::get_all()
+	 * @param string $field_to_select @see EEM_Base::get_col()
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_var($query_params = array(), $field_to_select = null)
+	{
+		$query_params['limit'] = 1;
+		$col = $this->get_col($query_params, $field_to_select);
+		if ( ! empty($col)) {
+			return reset($col);
+		} else {
+			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
+	 *
+	 * @global      $wpdb
+	 * @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
+	 */
+	public function _construct_update_sql($fields_n_values)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$cols_n_values = array();
+		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
+	 * @return boolean whether the row got deleted or not
+	 * @throws \EE_Error
+	 */
+	public function delete_permanently_by_ID($id)
+	{
+		return $this->delete_permanently(
+			array(
+				array($this->get_primary_key_field()->get_name() => $id),
+				'limit' => 1,
+			)
+		);
+	}
+
+
+
+	/**
+	 * 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
+	 * @return boolean whether the row got deleted or not
+	 * @throws \EE_Error
+	 */
+	public function delete_by_ID($id)
+	{
+		return $this->delete(
+			array(
+				array($this->get_primary_key_field()->get_name() => $id),
+				'limit' => 1,
+			)
+		);
+	}
+
+
+
+	/**
+	 * 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.
+	 *
+	 * @see EEM_Base::delete_permanently
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking
+	 * @return int how many rows got deleted
+	 * @throws \EE_Error
+	 */
+	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   very much like EEM_Base::get_all's $query_params
+	 * @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
+	 */
+	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 EEM_Base::get_all()
+		 * @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);
+		$deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
+		if ($deletion_where) {
+			//echo "objects for deletion:";var_dump($objects_for_deletion);
+			$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;
+			//		/echo "delete sql:$SQL";
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
+		} else {
+			$rows_deleted = 0;
+		}
+		//and lastly make sure those items are removed from the entity map; if they could be put into it at all
+		if ($this->has_primary_key_field()) {
+			foreach ($items_for_deletion as $item_for_deletion_row) {
+				$pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
+				}
+			}
+		}
+		/**
+		 * 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 EEM_Base::get_all()
+		 * @param int      $rows_deleted
+		 */
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
+		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
+	 */
+	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, array(
+						array(
+							$ignored_model->get_primary_key_field()->get_name() => array(
+								'!=',
+								$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;
+	}
+
+
+
+	/**
+	 * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
+	 * well.
+	 *
+	 * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
+	 * @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
+	 * @throws EE_Error
+	 * @return string    everything that comes after the WHERE statement.
+	 */
+	protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
+	{
+		if ($this->has_primary_key_field()) {
+			$primary_table = $this->_get_main_table();
+			$other_tables = $this->_get_other_tables();
+			$deletes = $query = array();
+			foreach ($objects_for_deletion as $delete_object) {
+				//before we mark this object for deletion,
+				//make sure there's no related objects blocking its deletion (if we're checking)
+				if (
+					$allow_blocking
+					&& $this->delete_is_blocked_by_related_models(
+						$delete_object[$primary_table->get_fully_qualified_pk_column()]
+					)
+				) {
+					continue;
+				}
+				//primary table deletes
+				if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
+					$deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
+				}
+				//other tables
+				if ( ! empty($other_tables)) {
+					foreach ($other_tables as $ot) {
+						//first check if we've got the foreign key column here.
+						if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
+						}
+						// wait! it's entirely possible that we'll have a the primary key
+						// for this table in here, if it's a foreign key for one of the other secondary tables
+						if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
+						}
+						// finally, it is possible that the fk for this table is found
+						// in the fully qualified pk column for the fk table, so let's see if that's there!
+						if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
+						}
+					}
+				}
+			}
+			//we should have deletes now, so let's just go through and setup the where statement
+			foreach ($deletes as $column => $values) {
+				//make sure we have unique $values;
+				$values = array_unique($values);
+				$query[] = $column . ' IN(' . implode(",", $values) . ')';
+			}
+			return ! empty($query) ? implode(' AND ', $query) : '';
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
+			$ways_to_identify_a_row = array();
+			$fields = $this->get_combined_primary_key_fields();
+			//note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
+			foreach ($objects_for_deletion as $delete_object) {
+				$values_for_each_cpk_for_a_row = array();
+				foreach ($fields as $cpk_field) {
+					if ($cpk_field instanceof EE_Model_Field_Base) {
+						$values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
+														   . "="
+														   . $delete_object[$cpk_field->get_qualified_column()];
+					}
+				}
+				$ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
+			}
+			return implode(" OR ", $ways_to_identify_a_row);
+		} else {
+			//so there's no primary key and no combined key...
+			//sorry, can't help you
+			throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
+				"event_espresso"), get_class($this)));
+		}
+	}
+
+
+
+	/**
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
+	 * 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   like EEM_Base::get_all's
+	 * @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 = array(), $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 = array();
+				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', array($SQL));
+	}
+
+
+
+	/**
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @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', array($SQL));
+		$data_type = $field_obj->get_wpdb_data_type();
+		if ($data_type === '%d' || $data_type === '%s') {
+			return (float)$return_value;
+		} else {//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
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 * @return mixed
+	 */
+	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(__("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(__('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(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
+			} elseif ($result === false) {
+				throw new EE_Error(sprintf(__('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(
+					__('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(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;
+					break;
+			}
+			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(
+			__('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,
+			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(
+			__('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,
+			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 $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 = array()
+	) {
+		$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
+	 * @return boolean of success
+	 * @throws \EE_Error
+	 * @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.
+	 */
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		$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 = array())
+	{
+		$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 like EEM_Base::get_all
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	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
+	 */
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
+	{
+		$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
+	 */
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
+	{
+		$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   like EEM_Base::get_all's
+	 * @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 = array(),
+		$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'] = '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 like EEM_Base::get_all's
+	 * @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(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		//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'] = '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     like EEM_Base::get_all's
+	 * @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);
+		} else {
+			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(__("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 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;
+		} else {
+			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(array($uniqueness_where_params))) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							"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
+	 * @throws EE_Error
+	 * @return EE_Base_Class|array
+	 */
+	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(
+					__(
+						"%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 = array();
+		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 array();
+		} else {
+			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(array('default_where_conditions' => 'none', array($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
+	 * @throws EE_Error
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
+	 * @return int ID of new row inserted, or FALSE on failure
+	 */
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
+	{
+		global $wpdb;
+		$insertion_col_n_values = array();
+		$format_for_insertion = array();
+		$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',
+			array($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;
+			} else {
+				//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()];
+			}
+		} else {
+			//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)
+	{
+		//if this field doesn't allow nullable, don't allow it
+		if ( ! $field_obj->is_nullable()
+			 && (
+				 ! isset($fields_n_values[$field_obj->get_name()]) || $fields_n_values[$field_obj->get_name()] === null)
+		) {
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
+		}
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()]) ? $fields_n_values[$field_obj->get_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 && $field instanceof EE_Model_Field_Base) {
+			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"
+				case self::prepared_by_model_object:
+					$value = $field->prepare_for_use_in_db($value);
+				case self::prepared_for_use_in_db:
+					//leave the value alone
+			}
+			return $value;
+		} else {
+			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(__('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 = array();
+		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 like EEM_Base::get_all's $query_parameters['where']
+	 * @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'
+			);
+		}
+		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 like EEM_Base::get_all's $query_params[0] or
+	 *                                                      $query_params['having']
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @return \EE_Model_Query_Info_Carrier
+	 */
+	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(__("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));
+					} else {
+						$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(__("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 like EEM_Base::get_all's $query_params[0] or
+	 *                                                      $query_params['having']
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @throws EE_Error
+	 * @return \EE_Model_Query_Info_Carrier
+	 */
+	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(__("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 $query_params (an array like whats passed to EEM_Base::get_all)
+	 * 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
+	 * @throws EE_Error
+	 * @return EE_Model_Query_Info_Carrier
+	 */
+	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(
+					__(
+						'$query_params should be an array, you passed a variable of type %s',
+						'event_espresso'
+					),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = array();
+		}
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
+		//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] = $where_query_params = array_replace_recursive(
+				$where_query_params,
+				$this->caps_where_conditions(
+					$query_params['caps']
+				)
+			);
+		}
+		$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 ($where_query_params as $key => $value) {
+			if (is_int($key)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							"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 = 'all';
+		}
+		$where_query_params = array_merge(
+			$this->_get_default_where_conditions_for_models_in_query(
+				$query_object,
+				$use_default_where_conditions,
+				$where_query_params
+			),
+			$where_query_params
+		);
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
+		// 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(
+						__(
+							"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(
+							__(
+								"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 = 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 = 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(
+						__(
+							"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 like EEM_Base::get_all() 's $query_params[0]
+	 * @throws \EE_Error
+	 */
+	public function caps_where_conditions($context = self::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		$cap_where_conditions = array();
+		$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;
+		} else {
+			throw new EE_Error(sprintf(__("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           like EEM_Base::get_all's $query_params[0]
+	 * @throws EE_Error
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
+	 */
+	private function _get_default_where_conditions_for_models_in_query(
+		EE_Model_Query_Info_Carrier $query_info_carrier,
+		$use_default_where_conditions = 'all',
+		$where_query_params = array()
+	) {
+		$allowed_used_default_where_conditions_values = array(
+			'all',
+			'this_model_only',
+			'other_models_only',
+			'minimum',
+			'none',
+		);
+		if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
+			throw new EE_Error(sprintf(__("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 = array();
+		if ($use_default_where_conditions === 'all' || $use_default_where_conditions === 'this_model_only') {
+			$universal_query_params = $this->_get_default_where_conditions();
+		} else if ($use_default_where_conditions === 'minimum') {
+			$universal_query_params = $this->_get_minimum_where_conditions();
+		}
+		if (in_array($use_default_where_conditions, array('all', 'other_models_only'))) {
+			foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
+				$related_model = $this->get_related_model_obj($model_name);
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
+				$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;
+	}
+
+
+
+	/**
+	 * 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 like EEM_Base::get_all's $query_params[0]
+	 * @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 = array();
+		$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()] = array('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 like EEM_Base::get_all's $query_params[0] (where conditions)
-     */
-    private function _get_default_where_conditions($model_relation_path = null)
-    {
-        if ($this->_ignore_where_strategy) {
-            return array();
-        }
-        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 like EEM_Base::get_all's $query_params[0] (where conditions)
-     */
-    protected function _get_minimum_where_conditions($model_relation_path = null)
-    {
-        if ($this->_ignore_where_strategy) {
-            return array();
-        }
-        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 = array();
-        $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
-     * @throws EE_Error
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
-     */
-    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);
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
-        //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)) {
-            if ($allow_fields) {
-                return;
-            } else {
-                throw new EE_Error(sprintf(__("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
-        elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
-            if ($allow_logic_query_params) {
-                return;
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __('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
-        elseif (array_key_exists($query_param, $this->_custom_selections)) {
-            return;
-        }
-        //check if has a model name at the beginning
-        //and
-        //check if it's a field on a related model
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
-                if ($query_param === '') {
-                    //nothing left to $query_param
-                    //we should actually end in a field name, not a model like this!
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
-                        "event_espresso"),
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
-                } else {
-                    $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
-                    $related_model_obj->_extract_related_model_info_from_query_param($query_param,
-                        $passed_in_query_info, $query_param_type, $original_query_param);
-                    return;
-                }
-            } elseif ($query_param === $valid_related_model_name) {
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
-                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(__("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));
-    }
-
-
-
-    /**
-     * 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);
-            $new_query_info = new EE_Model_Query_Info_Carrier(
-                array($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));
-            $passed_in_query_info->merge($new_query_info);
-        }
-        //now just join to the other table pointed to by the relation object, and add its data types
-        $new_query_info = new EE_Model_Query_Info_Carrier(
-            array($model_relation_chain => $model_name),
-            $relation_obj->get_join_statement($model_relation_chain));
-        $passed_in_query_info->merge($new_query_info);
-    }
-
-
-
-    /**
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
-     *
-     * @param array $where_params like EEM_Base::get_all
-     * @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;
-        } else {
-            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;
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
-     * EEM_Attendee.
-     *
-     * @param string $field_name
-     * @param string $model_name
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    protected function _get_field_on_model($field_name, $model_name)
-    {
-        $model_class = 'EEM_' . $model_name;
-        $model_filepath = $model_class . ".model.php";
-        if (is_readable($model_filepath)) {
-            require_once($model_filepath);
-            $model_instance = call_user_func($model_name . "::instance");
-            /* @var $model_instance EEM_Base */
-            return $model_instance->field_settings_for($field_name);
-        } else {
-            throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
-                'event_espresso'), $model_name, $model_class, $model_filepath));
-        }
-    }
-
-
-
-    /**
-     * 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 EEM_Base::get_all for documentation
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
-     * @throws EE_Error
-     * @return string of SQL
-     */
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
-    {
-        $where_clauses = array();
-        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);//str_replace("*",'',$query_param);
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
-                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 (isset($this->_custom_selections[$query_param][1])) {
-                        $field_obj = $this->_custom_selections[$query_param][1];
-                    } else {
-                        throw new EE_Error(sprintf(__("%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 array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @throws EE_Error
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
-     */
-    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();
-        } elseif (array_key_exists($query_param, $this->_custom_selections)) {
-            //maybe it's custom selection item?
-            //if so, just use it as the "column name"
-            return $query_param;
-        } else {
-            throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
-                "event_espresso"), $query_param, implode(",", $this->_custom_selections)));
-        }
-    }
-
-
-
-    /**
-     * 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;
-        } else {
-            $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
-     * @throws EE_Error
-     * @return string
-     */
-    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 = array();
-                foreach ($op_and_value as $key => $value) {
-                    $php_array_like_string[] = "$key=>$value";
-                }
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "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);
-        } elseif (in_array($operator, $this->_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;
-        } elseif (in_array($operator, $this->_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(
-                        __(
-                            "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;
-        } elseif (in_array($operator, $this->_null_style_operators)) {
-            if ($value !== null) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
-                            "event_espresso"
-                        ),
-                        $value,
-                        $operator
-                    )
-                );
-            }
-            return $operator;
-        } elseif ($operator === 'LIKE' && ! 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');
-        } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
-        } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        } elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "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 = array();
-        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)
-    {
-        //check if the value is a CSV list
-        if (is_string($values)) {
-            //in which case, turn it into an array
-            $values = explode(",", $values);
-        }
-        $cleaned_values = array();
-        foreach ($values as $value) {
-            $cleaned_values[] = $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($cleaned_values)) {
-            $all_fields = $this->field_settings();
-            $a_field = array_shift($all_fields);
-            $main_table = $this->_get_main_table();
-            $cleaned_values[] = "SELECT "
-                                . $a_field->get_table_column()
-                                . " FROM "
-                                . $main_table->get_table_name()
-                                . " WHERE FALSE";
-        }
-        return "(" . implode(",", $cleaned_values) . ")";
-    }
-
-
-
-    /**
-     * @param mixed                      $value
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
-     * @throws EE_Error
-     * @return false|null|string
-     */
-    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));
-        } else {//$field_obj should really just be a data type
-            if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
-                throw new EE_Error(sprintf(__("%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
-     * @throws EE_Error
-     * @return EE_Model_Field_Base
-     */
-    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(__("_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
-     * @throws EE_Error
-     * @return string
-     */
-    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();
-        } else {
-            throw new EE_Error(sprintf(__("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)));
-        }
-    }
-
-
-
-    /**
-     * 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.
-     */
-    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
-     */
-    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 = array();
-        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
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    public function get_related_model_obj($model_name)
-    {
-        $model_classname = "EEM_" . $model_name;
-        if ( ! class_exists($model_classname)) {
-            throw new EE_Error(sprintf(__("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 = array();
-        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
-     * @throws EE_Error
-     * @return EE_Model_Relation_Base
-     */
-    public function related_settings_for($relation_name)
-    {
-        $relatedModels = $this->relation_settings();
-        if ( ! array_key_exists($relation_name, $relatedModels)) {
-            throw new EE_Error(
-                sprintf(
-                    __('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
-     * @throws EE_Error
-     * @return EE_Model_Field_Base
-     */
-    public function field_settings_for($fieldName)
-    {
-        $fieldSettings = $this->field_settings(true);
-        if ( ! array_key_exists($fieldName, $fieldSettings)) {
-            throw new EE_Error(sprintf(__("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;
-        } else {
-            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;
-        } else {
-            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_Model_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(__("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(__("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 actual table 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 EE_Table_Base
-     */
-    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 = array();
-                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;
-        } else {
-            if ($this->_cached_fields_non_db_only === null) {
-                $this->_cached_fields_non_db_only = array();
-                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
-     */
-    protected function _create_objects($rows = array())
-    {
-        $array_of_objects = array();
-        if (empty($rows)) {
-            return array();
-        }
-        $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 array();
-            }
-            //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(
-                        __('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);
-                    }
-                }
-            }
-        }
-        return $array_of_objects;
-    }
-
-
-
-    /**
-     * 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.
-     */
-    public function create_default_object()
-    {
-        $this_model_fields_and_values = array();
-        //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();
-        $classInstance = EE_Registry::instance()
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
-        return $classInstance;
-    }
-
-
-
-    /**
-     * @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
-     */
-    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;
-            }
-        } else if ($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,
-                                                array($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, array($this_model_fields_n_values, $this->_timezone),
-                                            true, false);
-        }
-        //it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
-        $this->set_timezone($classInstance->get_timezone());
-        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
-     * @throws EE_Error
-     * @return \EE_Base_Class
-     */
-    public function add_to_entity_map(EE_Base_Class $object)
-    {
-        $className = $this->_get_class_name();
-        if ( ! $object instanceof $className) {
-            throw new EE_Error(sprintf(__("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(__("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;
-        } else {
-            $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] = array();
-            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
-     */
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
-    {
-        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 string $cols_n_values
-     * @return array
-     */
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
-    {
-        $this_model_fields_n_values = array();
-        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
-     */
-    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];
-        }
-        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
-     * @throws \EE_Error
-     */
-    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(
-                array(array($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);
-                }
-            }
-            return $obj_in_map;
-        } else {
-            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
-     */
-    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;
-        } else {
-            $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 $quantity
-     * @return string
-     */
-    public function item_name($quantity = 1)
-    {
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_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');
-     * $answer=EEM_Answer::instance();
-     * echo $answer->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
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if ( ! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __('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
-     * @throws EE_Error
-     * @return EE_Base_Class
-     */
-    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);
-            } else if (
-                $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(
-                        __(
-                            "'%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
-     */
-    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(__("'%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 = array();
-        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 array($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 $cols_n_values keys are field names, values are their values
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_index_primary_key_string($cols_n_values)
-    {
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_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
-     *
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
-     * @param string $index_primary_key_string
-     * @return null|array
-     * @throws \EE_Error
-     */
-    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 = array();
-        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                     like EEM_Base::get_all's query_params.
-     * @throws EE_Error
-     * @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 = array())
-    {
-        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(__("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
-     */
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
-    {
-        if ( ! is_array($query_params)) {
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)), '4.6.0');
-            $query_params = array();
-        }
-        $query_params['limit'] = 1;
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
-        if (is_array($copies)) {
-            return array_shift($copies);
-        } else {
-            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
-     */
-    public function update_by_ID($fields_n_values, $id)
-    {
-        $query_params = array(
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
-            'default_where_conditions' => 'other_models_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 = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
-            : null;
-        if ($sql_operator) {
-            return $sql_operator;
-        } else {
-            throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
-                "event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_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
-     */
-    public function get_all_names($query_params = array())
-    {
-        $objs = $this->get_all($query_params);
-        $names = array();
-        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
-     */
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
-    {
-        if ( ! $this->has_primary_key_field()) {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $IDs = array();
-        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(
-                        __(
-                            '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 (@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)
-     *
-     * @param string $context
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
-     * @throws \EE_Error
-     */
-    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 = array();
-        $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(
-                __('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
-     */
-    static public function valid_cap_contexts()
-    {
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
-            self::caps_read,
-            self::caps_read_admin,
-            self::caps_edit,
-            self::caps_delete,
-        ));
-    }
-
-
-
-    /**
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
-     *
-     * @param string $context
-     * @return bool
-     * @throws \EE_Error
-     */
-    static public function verify_is_valid_cap_context($context)
-    {
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_cap_contexts)) {
-            return true;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('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 = array();
-        $this->_cached_fields = null;
-        $this->_cached_fields_non_db_only = 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 like EEM_Base::get_all's $query_params[0] (where conditions)
+	 */
+	private function _get_default_where_conditions($model_relation_path = null)
+	{
+		if ($this->_ignore_where_strategy) {
+			return array();
+		}
+		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 like EEM_Base::get_all's $query_params[0] (where conditions)
+	 */
+	protected function _get_minimum_where_conditions($model_relation_path = null)
+	{
+		if ($this->_ignore_where_strategy) {
+			return array();
+		}
+		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 = array();
+		$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
+	 * @throws EE_Error
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
+	 */
+	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);
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
+		//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)) {
+			if ($allow_fields) {
+				return;
+			} else {
+				throw new EE_Error(sprintf(__("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
+		elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
+			if ($allow_logic_query_params) {
+				return;
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__('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
+		elseif (array_key_exists($query_param, $this->_custom_selections)) {
+			return;
+		}
+		//check if has a model name at the beginning
+		//and
+		//check if it's a field on a related model
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
+				if ($query_param === '') {
+					//nothing left to $query_param
+					//we should actually end in a field name, not a model like this!
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
+						"event_espresso"),
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
+				} else {
+					$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
+					$related_model_obj->_extract_related_model_info_from_query_param($query_param,
+						$passed_in_query_info, $query_param_type, $original_query_param);
+					return;
+				}
+			} elseif ($query_param === $valid_related_model_name) {
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
+				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(__("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));
+	}
+
+
+
+	/**
+	 * 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);
+			$new_query_info = new EE_Model_Query_Info_Carrier(
+				array($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));
+			$passed_in_query_info->merge($new_query_info);
+		}
+		//now just join to the other table pointed to by the relation object, and add its data types
+		$new_query_info = new EE_Model_Query_Info_Carrier(
+			array($model_relation_chain => $model_name),
+			$relation_obj->get_join_statement($model_relation_chain));
+		$passed_in_query_info->merge($new_query_info);
+	}
+
+
+
+	/**
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
+	 *
+	 * @param array $where_params like EEM_Base::get_all
+	 * @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;
+		} else {
+			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;
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
+	 * EEM_Attendee.
+	 *
+	 * @param string $field_name
+	 * @param string $model_name
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_field_on_model($field_name, $model_name)
+	{
+		$model_class = 'EEM_' . $model_name;
+		$model_filepath = $model_class . ".model.php";
+		if (is_readable($model_filepath)) {
+			require_once($model_filepath);
+			$model_instance = call_user_func($model_name . "::instance");
+			/* @var $model_instance EEM_Base */
+			return $model_instance->field_settings_for($field_name);
+		} else {
+			throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
+				'event_espresso'), $model_name, $model_class, $model_filepath));
+		}
+	}
+
+
+
+	/**
+	 * 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 EEM_Base::get_all for documentation
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
+	 * @throws EE_Error
+	 * @return string of SQL
+	 */
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
+	{
+		$where_clauses = array();
+		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);//str_replace("*",'',$query_param);
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
+				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 (isset($this->_custom_selections[$query_param][1])) {
+						$field_obj = $this->_custom_selections[$query_param][1];
+					} else {
+						throw new EE_Error(sprintf(__("%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 array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @throws EE_Error
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
+	 */
+	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();
+		} elseif (array_key_exists($query_param, $this->_custom_selections)) {
+			//maybe it's custom selection item?
+			//if so, just use it as the "column name"
+			return $query_param;
+		} else {
+			throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
+				"event_espresso"), $query_param, implode(",", $this->_custom_selections)));
+		}
+	}
+
+
+
+	/**
+	 * 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;
+		} else {
+			$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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	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 = array();
+				foreach ($op_and_value as $key => $value) {
+					$php_array_like_string[] = "$key=>$value";
+				}
+				throw new EE_Error(
+					sprintf(
+						__(
+							"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);
+		} elseif (in_array($operator, $this->_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;
+		} elseif (in_array($operator, $this->_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(
+						__(
+							"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;
+		} elseif (in_array($operator, $this->_null_style_operators)) {
+			if ($value !== null) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
+							"event_espresso"
+						),
+						$value,
+						$operator
+					)
+				);
+			}
+			return $operator;
+		} elseif ($operator === 'LIKE' && ! 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');
+		} elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
+		} elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		} elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"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 = array();
+		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)
+	{
+		//check if the value is a CSV list
+		if (is_string($values)) {
+			//in which case, turn it into an array
+			$values = explode(",", $values);
+		}
+		$cleaned_values = array();
+		foreach ($values as $value) {
+			$cleaned_values[] = $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($cleaned_values)) {
+			$all_fields = $this->field_settings();
+			$a_field = array_shift($all_fields);
+			$main_table = $this->_get_main_table();
+			$cleaned_values[] = "SELECT "
+								. $a_field->get_table_column()
+								. " FROM "
+								. $main_table->get_table_name()
+								. " WHERE FALSE";
+		}
+		return "(" . implode(",", $cleaned_values) . ")";
+	}
+
+
+
+	/**
+	 * @param mixed                      $value
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
+	 * @throws EE_Error
+	 * @return false|null|string
+	 */
+	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));
+		} else {//$field_obj should really just be a data type
+			if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
+				throw new EE_Error(sprintf(__("%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
+	 * @throws EE_Error
+	 * @return EE_Model_Field_Base
+	 */
+	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(__("_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
+	 * @throws EE_Error
+	 * @return string
+	 */
+	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();
+		} else {
+			throw new EE_Error(sprintf(__("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)));
+		}
+	}
+
+
+
+	/**
+	 * 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.
+	 */
+	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
+	 */
+	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 = array();
+		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
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	public function get_related_model_obj($model_name)
+	{
+		$model_classname = "EEM_" . $model_name;
+		if ( ! class_exists($model_classname)) {
+			throw new EE_Error(sprintf(__("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 = array();
+		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
+	 * @throws EE_Error
+	 * @return EE_Model_Relation_Base
+	 */
+	public function related_settings_for($relation_name)
+	{
+		$relatedModels = $this->relation_settings();
+		if ( ! array_key_exists($relation_name, $relatedModels)) {
+			throw new EE_Error(
+				sprintf(
+					__('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
+	 * @throws EE_Error
+	 * @return EE_Model_Field_Base
+	 */
+	public function field_settings_for($fieldName)
+	{
+		$fieldSettings = $this->field_settings(true);
+		if ( ! array_key_exists($fieldName, $fieldSettings)) {
+			throw new EE_Error(sprintf(__("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;
+		} else {
+			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;
+		} else {
+			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_Model_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(__("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(__("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 actual table 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 EE_Table_Base
+	 */
+	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 = array();
+				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;
+		} else {
+			if ($this->_cached_fields_non_db_only === null) {
+				$this->_cached_fields_non_db_only = array();
+				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
+	 */
+	protected function _create_objects($rows = array())
+	{
+		$array_of_objects = array();
+		if (empty($rows)) {
+			return array();
+		}
+		$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 array();
+			}
+			//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(
+						__('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);
+					}
+				}
+			}
+		}
+		return $array_of_objects;
+	}
+
+
+
+	/**
+	 * 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.
+	 */
+	public function create_default_object()
+	{
+		$this_model_fields_and_values = array();
+		//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();
+		$classInstance = EE_Registry::instance()
+									->load_class($className, array($this_model_fields_and_values), false, false);
+		return $classInstance;
+	}
+
+
+
+	/**
+	 * @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
+	 */
+	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;
+			}
+		} else if ($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,
+												array($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, array($this_model_fields_n_values, $this->_timezone),
+											true, false);
+		}
+		//it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
+		$this->set_timezone($classInstance->get_timezone());
+		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
+	 * @throws EE_Error
+	 * @return \EE_Base_Class
+	 */
+	public function add_to_entity_map(EE_Base_Class $object)
+	{
+		$className = $this->_get_class_name();
+		if ( ! $object instanceof $className) {
+			throw new EE_Error(sprintf(__("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(__("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;
+		} else {
+			$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] = array();
+			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
+	 */
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
+	{
+		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 string $cols_n_values
+	 * @return array
+	 */
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
+	{
+		$this_model_fields_n_values = array();
+		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
+	 */
+	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];
+		}
+		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
+	 * @throws \EE_Error
+	 */
+	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(
+				array(array($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);
+				}
+			}
+			return $obj_in_map;
+		} else {
+			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
+	 */
+	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;
+		} else {
+			$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 $quantity
+	 * @return string
+	 */
+	public function item_name($quantity = 1)
+	{
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_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');
+	 * $answer=EEM_Answer::instance();
+	 * echo $answer->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
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if ( ! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__('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
+	 * @throws EE_Error
+	 * @return EE_Base_Class
+	 */
+	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);
+			} else if (
+				$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(
+						__(
+							"'%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
+	 */
+	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(__("'%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 = array();
+		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 array($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 $cols_n_values keys are field names, values are their values
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_index_primary_key_string($cols_n_values)
+	{
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_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
+	 *
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
+	 * @param string $index_primary_key_string
+	 * @return null|array
+	 * @throws \EE_Error
+	 */
+	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 = array();
+		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                     like EEM_Base::get_all's query_params.
+	 * @throws EE_Error
+	 * @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 = array())
+	{
+		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(__("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
+	 */
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
+	{
+		if ( ! is_array($query_params)) {
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)), '4.6.0');
+			$query_params = array();
+		}
+		$query_params['limit'] = 1;
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
+		if (is_array($copies)) {
+			return array_shift($copies);
+		} else {
+			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
+	 */
+	public function update_by_ID($fields_n_values, $id)
+	{
+		$query_params = array(
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
+			'default_where_conditions' => 'other_models_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 = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
+			: null;
+		if ($sql_operator) {
+			return $sql_operator;
+		} else {
+			throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
+				"event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_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
+	 */
+	public function get_all_names($query_params = array())
+	{
+		$objs = $this->get_all($query_params);
+		$names = array();
+		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
+	 */
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
+	{
+		if ( ! $this->has_primary_key_field()) {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$IDs = array();
+		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(
+						__(
+							'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 (@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)
+	 *
+	 * @param string $context
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
+	 * @throws \EE_Error
+	 */
+	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 = array();
+		$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(
+				__('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
+	 */
+	static public function valid_cap_contexts()
+	{
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
+			self::caps_read,
+			self::caps_read_admin,
+			self::caps_edit,
+			self::caps_delete,
+		));
+	}
+
+
+
+	/**
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
+	 *
+	 * @param string $context
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	static public function verify_is_valid_cap_context($context)
+	{
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_cap_contexts)) {
+			return true;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('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 = array();
+		$this->_cached_fields = null;
+		$this->_cached_fields_non_db_only = null;
+	}
 
 
 

core/middleware/EE_Recommended_Versions.core.php

Indentation +151 added lines, -151 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,162 +18,162 @@ 
 {
 
 
-    /**
-     * converts a Request to a Response
-     *
-     * @param    EE_Request  $request
-     * @param    EE_Response $response
-     * @return    EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        $this->_request = $request;
-        $this->_response = $response;
-        //$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
-        //$this->_response->set_notice( 1, 'hey look at this' );
-        // check required WP version
-        if ( ! $this->_minimum_wp_version_required()) {
-            $this->_request->un_set('activate', true);
-            add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
-            //$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
-            $this->_response->terminate_request();
-            $this->_response->deactivate_plugin();
-        }
-        // check required PHP version
-        if ( ! $this->_minimum_php_version_required()) {
-            $this->_request->un_set('activate', true);
-            add_action('admin_notices', array($this, 'minimum_php_version_error'), 1);
-            //$this->_response->add_output( "\n<br />" . 'minimum_php_version_error' );
-            $this->_response->terminate_request();
-            $this->_response->deactivate_plugin();
-        }
-        // check recommended PHP version
-        if ( ! $this->_minimum_php_version_recommended()) {
-            $this->_display_minimum_recommended_php_version_notice();
-        }
-        $this->_response = $this->process_request_stack($this->_request, $this->_response);
-        //$this->_response->add_output( "\n\t OUT << " . __CLASS__ );
-        return $this->_response;
-    }
-
-
-
-    /**
-     *    _check_wp_version
-     *
-     * @access private
-     * @param string $min_version
-     * @return boolean
-     */
-    private function _check_wp_version($min_version = EE_MIN_WP_VER_REQUIRED)
-    {
-        global $wp_version;
-        return version_compare($wp_version, $min_version, '>=') ? true : false;
-    }
-
-
-
-    /**
-     *    _minimum_wp_version_required
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _minimum_wp_version_required()
-    {
-        return $this->_check_wp_version(EE_MIN_WP_VER_REQUIRED);
-    }
-
-
-
-    /**
-     *    _check_php_version
-     *
-     * @access private
-     * @param string $min_version
-     * @return boolean
-     */
-    private function _check_php_version($min_version = EE_MIN_PHP_VER_RECOMMENDED)
-    {
-        return version_compare(PHP_VERSION, $min_version, '>=') ? true : false;
-    }
-
-
-
-    /**
-     *    _minimum_php_version_required
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _minimum_php_version_required()
-    {
-        return $this->_check_php_version(EE_MIN_PHP_VER_REQUIRED);
-    }
-
-
-
-    /**
-     *    _minimum_php_version_recommended
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _minimum_php_version_recommended()
-    {
-        return $this->_check_php_version(EE_MIN_PHP_VER_RECOMMENDED);
-    }
-
-
-
-    /**
-     *    minimum_wp_version_error
-     *
-     * @return void
-     */
-    public function minimum_wp_version_error()
-    {
-        global $wp_version;
-        ?>
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param    EE_Request  $request
+	 * @param    EE_Response $response
+	 * @return    EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		$this->_request = $request;
+		$this->_response = $response;
+		//$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
+		//$this->_response->set_notice( 1, 'hey look at this' );
+		// check required WP version
+		if ( ! $this->_minimum_wp_version_required()) {
+			$this->_request->un_set('activate', true);
+			add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
+			//$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
+			$this->_response->terminate_request();
+			$this->_response->deactivate_plugin();
+		}
+		// check required PHP version
+		if ( ! $this->_minimum_php_version_required()) {
+			$this->_request->un_set('activate', true);
+			add_action('admin_notices', array($this, 'minimum_php_version_error'), 1);
+			//$this->_response->add_output( "\n<br />" . 'minimum_php_version_error' );
+			$this->_response->terminate_request();
+			$this->_response->deactivate_plugin();
+		}
+		// check recommended PHP version
+		if ( ! $this->_minimum_php_version_recommended()) {
+			$this->_display_minimum_recommended_php_version_notice();
+		}
+		$this->_response = $this->process_request_stack($this->_request, $this->_response);
+		//$this->_response->add_output( "\n\t OUT << " . __CLASS__ );
+		return $this->_response;
+	}
+
+
+
+	/**
+	 *    _check_wp_version
+	 *
+	 * @access private
+	 * @param string $min_version
+	 * @return boolean
+	 */
+	private function _check_wp_version($min_version = EE_MIN_WP_VER_REQUIRED)
+	{
+		global $wp_version;
+		return version_compare($wp_version, $min_version, '>=') ? true : false;
+	}
+
+
+
+	/**
+	 *    _minimum_wp_version_required
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _minimum_wp_version_required()
+	{
+		return $this->_check_wp_version(EE_MIN_WP_VER_REQUIRED);
+	}
+
+
+
+	/**
+	 *    _check_php_version
+	 *
+	 * @access private
+	 * @param string $min_version
+	 * @return boolean
+	 */
+	private function _check_php_version($min_version = EE_MIN_PHP_VER_RECOMMENDED)
+	{
+		return version_compare(PHP_VERSION, $min_version, '>=') ? true : false;
+	}
+
+
+
+	/**
+	 *    _minimum_php_version_required
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _minimum_php_version_required()
+	{
+		return $this->_check_php_version(EE_MIN_PHP_VER_REQUIRED);
+	}
+
+
+
+	/**
+	 *    _minimum_php_version_recommended
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _minimum_php_version_recommended()
+	{
+		return $this->_check_php_version(EE_MIN_PHP_VER_RECOMMENDED);
+	}
+
+
+
+	/**
+	 *    minimum_wp_version_error
+	 *
+	 * @return void
+	 */
+	public function minimum_wp_version_error()
+	{
+		global $wp_version;
+		?>
         <div class="error">
             <p>
                 <?php
-                printf(
-                        __('We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.',
-                                'event_espresso'),
-                        EE_MIN_WP_VER_REQUIRED,
-                        $wp_version,
-                        '<br/>',
-                        '<a href="http://codex.wordpress.org/Updating_WordPress">http://codex.wordpress.org/Updating_WordPress</a>'
-                );
-                ?>
+				printf(
+						__('We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.',
+								'event_espresso'),
+						EE_MIN_WP_VER_REQUIRED,
+						$wp_version,
+						'<br/>',
+						'<a href="http://codex.wordpress.org/Updating_WordPress">http://codex.wordpress.org/Updating_WordPress</a>'
+				);
+				?>
             </p>
         </div>
         <?php
-    }
-
-
-
-    /**
-     *    _display_minimum_recommended_php_version_notice
-     *
-     * @access private
-     * @return void
-     */
-    private function _display_minimum_recommended_php_version_notice()
-    {
-        EE_Error::add_persistent_admin_notice(
-                'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
-                sprintf(
-                        __('Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                'event_espresso'),
-                        EE_MIN_PHP_VER_RECOMMENDED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                )
-        );
-    }
+	}
+
+
+
+	/**
+	 *    _display_minimum_recommended_php_version_notice
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _display_minimum_recommended_php_version_notice()
+	{
+		EE_Error::add_persistent_admin_notice(
+				'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
+				sprintf(
+						__('Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+								'event_espresso'),
+						EE_MIN_PHP_VER_RECOMMENDED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+				)
+		);
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
     private function _display_minimum_recommended_php_version_notice()
     {
         EE_Error::add_persistent_admin_notice(
-                'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
+                'php_version_'.str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED).'_recommended',
                 sprintf(
                         __('Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
                                 'event_espresso'),