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 +392 added lines, -392 removed lines

@@ -17,396 +17,396 @@
 class EE_Cart implements ResettableInterface
 {
 
-    /**
-     * 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 ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', 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 && $grand_total->is_total()) {
-            $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()
-    {
-        if ($this->_grand_total === null) {
-            return array();
-        }
-        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()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-            if ($deleted) {
-                $deleted += $this->_grand_total->delete();
-                $this->_grand_total = null;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @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 ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if (! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', 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 && $grand_total->is_total()) {
+			$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()
+	{
+		if ($this->_grand_total === null) {
+			return array();
+		}
+		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()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+			if ($deleted) {
+				$deleted += $this->_grand_total->delete();
+				$this->_grand_total = null;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @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');
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -65,14 +65,14 @@ 
             self::$_instance = new self($grand_total, $session);
         }
         // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
+        if ( ! self::$_instance instanceof EE_Cart) {
             // try getting the cart out of the session
             $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
             self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
             unset($saved_cart);
         }
         // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
             self::$_instance = new self($grand_total, $session);
         }
         self::$_instance->get_grand_total();
@@ -124,7 +124,7 @@ 
      */
     public function session()
     {
-        if (! $this->_session instanceof EE_Session) {
+        if ( ! $this->_session instanceof EE_Session) {
             $this->set_session();
         }
         return $this->_session;
@@ -392,7 +392,7 @@ 
 
     public function __wakeup()
     {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+        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);
         }

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 +1576 added lines, -1576 removed lines

@@ -15,232 +15,232 @@ 
 class EEH_Activation implements ResettableInterface
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var \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()
-    {
-        return EEH_Activation::create_database_tables();
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws \EE_Error
-     */
-    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();
-
-        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
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
-            )
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws \EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                /**
-                 * This allows client code to define the initial start timestamp for this schedule.
-                 */
-                if (is_array($frequency)
-                    && count($frequency) === 2
-                    && isset($frequency[0], $frequency[1])
-                ) {
-                    $start_timestamp = $frequency[0];
-                    $frequency = $frequency[1];
-                } else {
-                    $start_timestamp = time();
-                }
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
-            }
-        }
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws \EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : 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';
+
+	/**
+	 * 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()
+	{
+		return EEH_Activation::create_database_tables();
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws \EE_Error
+	 */
+	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();
+
+		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
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
+			)
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				/**
+				 * This allows client code to define the initial start timestamp for this schedule.
+				 */
+				if (is_array($frequency)
+					&& count($frequency) === 2
+					&& isset($frequency[0], $frequency[1])
+				) {
+					$start_timestamp = $frequency[0];
+					$frequency = $frequency[1];
+				} else {
+					$start_timestamp = time();
+				}
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
+			}
+		}
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws \EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : 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.
@@ -257,909 +257,909 @@ 
          *                  ...
          *      ...
          */
-        $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
-     * @throws InvalidDataTypeException
-     */
-    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;
-                    }
-                }
-            }
-            // 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) {
-            new PersistentAdminNotice(
-                'critical_page_problem',
-                sprintf(
-                    esc_html__(
-                        'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
-                    . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                    . '</a>'
-                )
-            );
-        }
-        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;
-        }
-    }
-
-
-    /**
-     *    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;
-    }
-
-
-
-
-    /**
-     * 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);
-            } elseif (! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        __(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    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 
+		$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
+	 * @throws InvalidDataTypeException
+	 */
+	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;
+					}
+				}
+			}
+			// 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) {
+			new PersistentAdminNotice(
+				'critical_page_problem',
+				sprintf(
+					esc_html__(
+						'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+					. __('Event Espresso Critical Pages Settings', 'event_espresso')
+					. '</a>'
+				)
+			);
+		}
+		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;
+		}
+	}
+
+
+	/**
+	 *    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;
+	}
+
+
+
+
+	/**
+	 * 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);
+			} elseif (! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    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
+							'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
+					'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', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID
+								),
+								'error'
+							);
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						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', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1199,457 +1199,457 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-        }
-    }
-
-
-    /**
-     * 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);
+		}
+	}
+
+
+	/**
+	 * 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() ] = $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 ] = $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,
-            RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = 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()
-    {
-        // phpcs:disable PHPCompatibility.PHP.RemovedExtensions.mysql_DeprecatedRemoved
-        global $wpdb;
-        if ($wpdb->use_mysqli) {
-            return mysqli_errno($wpdb->dbh);
-        } else {
-            return mysql_errno($wpdb->dbh);
-        }
-        // phpcs:enable
-    }
-
-    /**
-     * 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() ] = $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 ] = $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,
+			RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = 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()
+	{
+		// phpcs:disable PHPCompatibility.PHP.RemovedExtensions.mysql_DeprecatedRemoved
+		global $wpdb;
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
+		} else {
+			return mysql_errno($wpdb->dbh);
+		}
+		// phpcs:enable
+	}
+
+	/**
+	 * 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;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -54,7 +54,7 @@ 
      */
     public static function getTableAnalysis()
     {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+        if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
             self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
         }
         return self::$table_analysis;
@@ -66,7 +66,7 @@ 
      */
     public static function getTableManager()
     {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+        if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
             self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
         }
         return self::$table_manager;
@@ -180,7 +180,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;
                 }
             );
@@ -210,7 +210,7 @@ 
     {
 
         foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 /**
                  * This allows client code to define the initial start timestamp for this schedule.
                  */
@@ -261,15 +261,15 @@ 
         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 ])
+                    if (isset($ee_cron_tasks_to_remove[$hook_name])
+                        && is_array($ee_cron_tasks_to_remove[$hook_name])
                     ) {
-                        unset($crons[ $timestamp ][ $hook_name ]);
+                        unset($crons[$timestamp][$hook_name]);
                     }
                 }
                 // also take care of any empty cron timestamps.
                 if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[ $timestamp ]);
+                    unset($crons[$timestamp]);
                 }
             }
         }
@@ -314,7 +314,7 @@ 
             3
         );
         // EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             delete_option(EE_Config::LOG_NAME);
         }
     }
@@ -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;
         }
@@ -345,7 +345,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
@@ -472,7 +472,7 @@ 
             ) {
                 // update Config with post ID
                 $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
+                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
                     $msg = __(
                         'The Event Espresso critical page configuration settings could not be updated.',
                         'event_espresso'
@@ -495,7 +495,7 @@ 
                         'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+                    '<a href="'.admin_url('admin.php?page=espresso_general_settings&action=critical_pages').'">'
                     . __('Event Espresso Critical Pages Settings', 'event_espresso')
                     . '</a>'
                 )
@@ -521,7 +521,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);
@@ -547,11 +547,11 @@ 
             'post_status'    => 'publish',
             'post_type'      => 'page',
             'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
+            'post_content'   => '['.$critical_page['code'].']',
         );
 
         $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
+        if ( ! $post_id) {
             $msg = sprintf(
                 __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
                 $critical_page['name']
@@ -560,7 +560,7 @@ 
             return $critical_page;
         }
         // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
+        if ( ! $critical_page['post'] = get_post($post_id)) {
             $msg = sprintf(
                 __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
                 $critical_page['name']
@@ -585,7 +585,7 @@ 
     public static function get_default_creator_id()
     {
         global $wpdb;
-        if (! empty(self::$_default_creator_id)) {
+        if ( ! empty(self::$_default_creator_id)) {
             return self::$_default_creator_id;
         }/**/
         $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
@@ -601,7 +601,7 @@ 
         $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query = $wpdb->prepare(
             "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
+            '%'.$role_to_check.'%'
         );
         $user_id = $wpdb->get_var($query);
         $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
@@ -640,8 +640,8 @@ 
             return;
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+        if ( ! function_exists('dbDelta')) {
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = \EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -650,9 +650,9 @@ 
             // ok, delete the table... but ONLY if it's empty
             $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
             // table is NOT empty, are you SURE you want to delete this table ???
-            if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
                 \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } elseif (! $deleted_safely) {
+            } elseif ( ! $deleted_safely) {
                 // so we should be more cautious rather than just dropping tables so easily
                 error_log(
                     sprintf(
@@ -852,13 +852,13 @@ 
             // 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)) {
+            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_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -870,7 +870,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,
@@ -881,14 +881,14 @@ 
                         break;
                 }
                 // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
+                if ( ! empty($QSG_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
                         $QSG_values,
                         array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
                     );
-                    $QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
+                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
                 }
             }
         }
@@ -918,7 +918,7 @@ 
             // reset values array
             $QST_values = array();
             // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
+            if ( ! in_array($QST_system, $questions)) {
                 // add it
                 switch ($QST_system) {
                     case 'fname':
@@ -1070,7 +1070,7 @@ 
                         );
                         break;
                 }
-                if (! empty($QST_values)) {
+                if ( ! empty($QST_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -1084,8 +1084,8 @@ 
                     } 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 ];
+                    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)));
@@ -1133,7 +1133,7 @@ 
      */
     public static function insert_default_payment_methods()
     {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+        if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
         } else {
@@ -1270,7 +1270,7 @@ 
                         $active_messenger->name,
                         $default_message_type_name_for_messenger
                     )
-                    || ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
+                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
                 ) {
                     continue;
                 }
@@ -1283,7 +1283,7 @@ 
                 false
             );
             // activate the templates for these message types
-            if (! empty($default_message_type_names_to_activate)) {
+            if ( ! empty($default_message_type_names_to_activate)) {
                 $templates_created = EEH_MSG_Template::generate_new_templates(
                     $active_messenger->name,
                     $default_message_type_names_for_messenger,
@@ -1317,13 +1317,13 @@ 
             $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 ])
+                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 ]);
+                    unset($default_message_type_names_for_messenger[$key]);
                 }
             }
             // in previous iterations, the active_messengers option in the db
@@ -1337,7 +1337,7 @@ 
                 false
             );
             // create any templates needing created (or will reactivate templates already generated as necessary).
-            if (! empty($default_message_type_names_for_messenger)) {
+            if ( ! empty($default_message_type_names_for_messenger)) {
                 $templates_generated = EEH_MSG_Template::generate_new_templates(
                     $messenger_to_generate->name,
                     $default_message_type_names_for_messenger,
@@ -1372,13 +1372,13 @@ 
             // 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 ])
+            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;
+            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
         }
         return $messengers_to_generate;
     }
@@ -1416,7 +1416,7 @@ 
         // 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) {
+        if ( ! $espresso_no_ticket_prices) {
             add_option('ee_no_ticket_prices', array(), '', false);
         }
     }
@@ -1455,7 +1455,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) {
@@ -1484,7 +1484,7 @@ 
                                 || ! $table->is_global()// not main site,but not global either. nuke it
                             )
                         ) {
-                            $tables[ $table->get_table_name() ] = $table->get_table_name();
+                            $tables[$table->get_table_name()] = $table->get_table_name();
                         }
                     }
                 }
@@ -1501,7 +1501,7 @@ 
             'esp_rule',
         );
         foreach ($tables_without_models as $table) {
-            $tables[ $table ] = $table;
+            $tables[$table] = $table;
         }
         return \EEH_Activation::getTableManager()->dropTables($tables);
     }
@@ -1578,13 +1578,13 @@ 
         $undeleted_options = array();
         foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
             if ($no_wildcard) {
-                if (! delete_option($option_name)) {
+                if ( ! delete_option($option_name)) {
                     $undeleted_options[] = $option_name;
                 }
             } else {
                 $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
                 foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if (! delete_option($option_name_from_wildcard)) {
+                    if ( ! delete_option($option_name_from_wildcard)) {
                         $undeleted_options[] = $option_name_from_wildcard;
                     }
                 }
@@ -1596,20 +1596,20 @@ 
             $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;
+                    $db_update_sans_ee4[$version] = $times_activated;
                 }
             }
             update_option('espresso_db_update', $db_update_sans_ee4);
         }
         $errors = '';
-        if (! empty($undeleted_options)) {
+        if ( ! empty($undeleted_options)) {
             $errors .= sprintf(
                 __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
                 '<br/>',
                 implode(',<br/>', $undeleted_options)
             );
         }
-        if (! empty($errors)) {
+        if ( ! empty($errors)) {
             EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
         }
     }

core/db_models/EEM_Datetime.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -529,7 +529,7 @@
     /**
      * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
      *
-     * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
+     * @param  string[] $stati_to_include If included you can restrict the statuses we return counts for by including the
      *                                 stati you want counts for as values in the array.  An empty array returns counts
      *                                 for all valid stati.
      * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.

Indentation +743 added lines, -743 removed lines

@@ -13,747 +13,747 @@
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = array(
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        );
-        $this->_fields                 = array(
-            'Datetime' => array(
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations        = array(
-            'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'   => new EE_Belongs_To_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-        );
-        $path_to_event_model = 'Event';
-        $this->model_chain_to_password = $path_to_event_model;
-        $this->_model_chain_to_wp_user = $path_to_event_model;
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     */
-    public function create_new_blank_datetime()
-    {
-        // makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        /**
-         * Filters the initial start date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $start_date Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $start_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
-            $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
-        );
-        /**
-         * Filters the initial end date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $end_data Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $end_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
-            $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
-        );
-        $blank_datetime = EE_Datetime::new_instance(
-            array(
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ),
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return array($blank_datetime);
-    }
-
-
-    /**
-     * Validates whether the start_time and end_time are in the expected format.
-     * @param array $start_time
-     * @param array $end_time
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
-    {
-        if (! is_array($start_time)) {
-            throw new InvalidDataTypeException('start_time', $start_time, 'array');
-        }
-        if (! is_array($end_time)) {
-            throw new InvalidDataTypeException('end_time', $end_time, 'array');
-        }
-        if (count($start_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$start_time'
-                )
-            );
-        }
-        if (count($end_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$end_time'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param  int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_all_event_dates($EVT_ID = 0)
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param  int    $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param  int    $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Event.EVT_ID' => $EVT_ID);
-        $query_params = ! empty($limit)
-            ? array(
-                $where_params,
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-            : array(
-                $where_params,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
-    {
-        return $this->get_all(
-            array(
-                array('Event.EVT_ID' => $EVT_ID),
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-        );
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return \EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_primary_datetime_for_event(
-        $EVT_ID,
-        $try_to_exclude_expired = true,
-        $try_to_exclude_deleted = true
-    ) {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize TKT_ID
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
-     * @param  boolean  $include_expired whether to include expired datetimes or not
-     * @param  boolean  $include_deleted whether to include trashed datetimes or not.
-     * @param  int|null $limit           if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize id.
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Ticket.TKT_ID' => $TKT_ID);
-        $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_most_important_datetime_for_event($EVT_ID)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param  array  $where_params      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param  string $evt_active_status A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years($where_params, $evt_active_status = '')
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming':
-                $where_params['Event.status'] = 'publish';
-                // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
-                break;
-            case 'expired':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                // get events to exclude
-                $exclude_query[0] = array_merge(
-                    $where_params,
-                    array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end))
-                );
-                // first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
-                $where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
-                break;
-            case 'active':
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
-                $where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
-                break;
-            case 'inactive':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = array('!=', 'publish');
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = array('dtt_year', 'dtt_month');
-        $query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
-        $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     */
-    public function update_sold($datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     */
-    public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
-     *                                 stati you want counts for as values in the array.  An empty array returns counts
-     *                                 for all valid stati.
-     * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
-    {
-        // only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : array();
-        $status_query_args = array(
-            EE_Datetime::active   => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('>', time()))
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                array('DTT_EVT_end' => array('<', time()))
-            ),
-        );
-        if (! empty($stati_to_include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        // loop through and query counts for each stati.
-        $status_query_results = array();
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                array($status_where_conditions),
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
-    {
-        $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = array(
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		);
+		$this->_fields                 = array(
+			'Datetime' => array(
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations        = array(
+			'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'   => new EE_Belongs_To_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+		);
+		$path_to_event_model = 'Event';
+		$this->model_chain_to_password = $path_to_event_model;
+		$this->_model_chain_to_wp_user = $path_to_event_model;
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_new_blank_datetime()
+	{
+		// makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		/**
+		 * Filters the initial start date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $start_date Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$start_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
+			$this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
+		);
+		/**
+		 * Filters the initial end date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $end_data Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$end_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
+			$this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
+		);
+		$blank_datetime = EE_Datetime::new_instance(
+			array(
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			),
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return array($blank_datetime);
+	}
+
+
+	/**
+	 * Validates whether the start_time and end_time are in the expected format.
+	 * @param array $start_time
+	 * @param array $end_time
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
+	{
+		if (! is_array($start_time)) {
+			throw new InvalidDataTypeException('start_time', $start_time, 'array');
+		}
+		if (! is_array($end_time)) {
+			throw new InvalidDataTypeException('end_time', $end_time, 'array');
+		}
+		if (count($start_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$start_time'
+				)
+			);
+		}
+		if (count($end_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$end_time'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param  int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_all_event_dates($EVT_ID = 0)
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param  int    $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param  int    $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Event.EVT_ID' => $EVT_ID);
+		$query_params = ! empty($limit)
+			? array(
+				$where_params,
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+			: array(
+				$where_params,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
+	{
+		return $this->get_all(
+			array(
+				array('Event.EVT_ID' => $EVT_ID),
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+		);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return \EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_primary_datetime_for_event(
+		$EVT_ID,
+		$try_to_exclude_expired = true,
+		$try_to_exclude_deleted = true
+	) {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize TKT_ID
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
+	 * @param  boolean  $include_expired whether to include expired datetimes or not
+	 * @param  boolean  $include_deleted whether to include trashed datetimes or not.
+	 * @param  int|null $limit           if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize id.
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Ticket.TKT_ID' => $TKT_ID);
+		$query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_most_important_datetime_for_event($EVT_ID)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param  array  $where_params      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param  string $evt_active_status A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years($where_params, $evt_active_status = '')
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming':
+				$where_params['Event.status'] = 'publish';
+				// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
+				break;
+			case 'expired':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				// get events to exclude
+				$exclude_query[0] = array_merge(
+					$where_params,
+					array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end))
+				);
+				// first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
+				$where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
+				break;
+			case 'active':
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
+				$where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
+				break;
+			case 'inactive':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = array('!=', 'publish');
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = array('dtt_year', 'dtt_month');
+		$query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
+		$query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select        = array(
+			'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
+			'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
+			'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 */
+	public function update_sold($datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 */
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
+	 *                                 stati you want counts for as values in the array.  An empty array returns counts
+	 *                                 for all valid stati.
+	 * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
+	{
+		// only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : array();
+		$status_query_args = array(
+			EE_Datetime::active   => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('>', time()))
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				array('DTT_EVT_end' => array('<', time()))
+			),
+		);
+		if (! empty($stati_to_include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $stati_to_include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		// loop through and query counts for each stati.
+		$status_query_results = array();
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				array($status_where_conditions),
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
+	{
+		$count = $this->get_datetime_counts_by_status(array($status), $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -121,7 +121,7 @@ 
                 ),
             ),
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'   => new EE_Belongs_To_Relation(),
             'Checkin' => new EE_Has_Many_Relation(),
@@ -131,16 +131,16 @@ 
         $this->model_chain_to_password = $path_to_event_model;
         $this->_model_chain_to_wp_user = $path_to_event_model;
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
         );
@@ -246,10 +246,10 @@ 
      */
     private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
     {
-        if (! is_array($start_time)) {
+        if ( ! is_array($start_time)) {
             throw new InvalidDataTypeException('start_time', $start_time, 'array');
         }
-        if (! is_array($end_time)) {
+        if ( ! is_array($end_time)) {
             throw new InvalidDataTypeException('end_time', $end_time, 'array');
         }
         if (count($start_time) !== 2) {
@@ -283,7 +283,7 @@ 
      */
     public function get_all_event_dates($EVT_ID = 0)
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -329,7 +329,7 @@ 
                 'order_by'                 => array('DTT_order' => 'ASC'),
                 'default_where_conditions' => 'none',
             );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -440,7 +440,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -478,7 +478,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -518,7 +518,7 @@ 
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $where_params = array('Ticket.TKT_ID' => $TKT_ID);
         $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -641,10 +641,10 @@ 
             $this->get_timezone(),
             'DTT_EVT_start'
         );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+        $columns_to_select = array(
+            'dtt_year'      => array('YEAR('.$query_interval.')', '%s'),
+            'dtt_month'     => array('MONTHNAME('.$query_interval.')', '%s'),
+            'dtt_month_num' => array('MONTH('.$query_interval.')', '%s'),
         );
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -723,17 +723,17 @@ 
                 array('DTT_EVT_end' => array('<', time()))
             ),
         );
-        if (! empty($stati_to_include)) {
+        if ( ! empty($stati_to_include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $stati_to_include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         // loop through and query counts for each stati.
         $status_query_results = array();
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 array($status_where_conditions),
                 'DTT_ID',
                 true
@@ -754,6 +754,6 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
     {
         $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 }

public/Espresso_Arabica_2014/content-espresso_events-datetimes.php

Spacing +4 added lines, -4 removed lines

@@ -1,15 +1,15 @@
 <?php
 //echo '<br/><h6 style="color:#2EA2CC;">'. __FILE__ . ' &nbsp; <span style="font-weight:normal;color:#E76700"> Line #: ' . __LINE__ . '</span></h6>';
 
-if ( is_single() || ( is_archive() && espresso_display_datetimes_in_event_list() ) ) :
+if (is_single() || (is_archive() && espresso_display_datetimes_in_event_list())) :
 global $post;
-do_action( 'AHEE_event_details_before_event_date', $post );
+do_action('AHEE_event_details_before_event_date', $post);
 ?>
 	<div class="event-datetimes">
-		<?php espresso_list_of_event_dates( $post->ID );?>
+		<?php espresso_list_of_event_dates($post->ID); ?>
 	</div>
 	<!-- .event-datetimes -->
 <?php
-do_action( 'AHEE_event_details_after_event_date', $post );
+do_action('AHEE_event_details_after_event_date', $post);
 endif;
 ?>
\ No newline at end of file

admin_pages/registrations/Registrations_Admin_Page.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -1247,7 +1247,7 @@
     /**
      * Sets up the limit for the registrations query.
      *
-     * @param $per_page
+     * @param integer $per_page
      * @return array
      */
     protected function _get_limit($per_page)

Indentation +3823 added lines, -3823 removed lines

@@ -19,2396 +19,2396 @@ 
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * @var EE_Registration
-     */
-    private $_registration;
-
-    /**
-     * @var EE_Event
-     */
-    private $_reg_event;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    private static $_reg_status;
-
-    /**
-     * Form for displaying the custom questions for this registration.
-     * This gets used a few times throughout the request so its best to cache it
-     *
-     * @var EE_Registration_Custom_Questions_Form
-     */
-    protected $_reg_custom_questions_form = null;
-
-
-    /**
-     *        constructor
-     *
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @return Registrations_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        add_action('wp_loaded', array($this, 'wp_loaded'));
-    }
-
-
-    public function wp_loaded()
-    {
-        // when adding a new registration...
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
-            EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
-                || absint($this->_req_data['processing_registration']) !== 1
-            ) {
-                // and it's NOT the attendee information reg step
-                // force cookie expiration by setting time to last week
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
-                // and update the global
-                $_COOKIE['ee_registration_added'] = 0;
-            }
-        }
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = REG_PG_SLUG;
-        $this->_admin_base_url = REG_ADMIN_URL;
-        $this->_admin_base_path = REG_ADMIN;
-        $this->page_label = esc_html__('Registrations', 'event_espresso');
-        $this->_cpt_routes = array(
-            'add_new_attendee' => 'espresso_attendees',
-            'edit_attendee'    => 'espresso_attendees',
-            'insert_attendee'  => 'espresso_attendees',
-            'update_attendee'  => 'espresso_attendees',
-        );
-        $this->_cpt_model_names = array(
-            'add_new_attendee' => 'EEM_Attendee',
-            'edit_attendee'    => 'EEM_Attendee',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_attendees' => 'edit_attendee',
-        );
-        $this->_pagenow_map = array(
-            'add_new_attendee' => 'post-new.php',
-            'edit_attendee'    => 'post.php',
-            'trash'            => 'post.php',
-        );
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
-        // add filters so that the comment urls don't take users to a confusing 404 page
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
-    }
-
-
-    public function clear_comment_link($link, $comment, $args)
-    {
-        // gotta make sure this only happens on this route
-        $post_type = get_post_type($comment->comment_post_ID);
-        if ($post_type === 'espresso_attendees') {
-            return '#commentsdiv';
-        }
-        return $link;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for registrations ajax goes in here
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'buttons'                      => array(
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
-                'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
-                'contact_list_export' => esc_html__("Export Data", "event_espresso"),
-            ),
-            'publishbox'                   => array(
-                'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
-                'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
-            ),
-            'hide_add_button_on_cpt_route' => array(
-                'edit_attendee' => true,
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     */
-    public function _set_page_routes()
-    {
-        $this->_get_registration_status_array();
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID'] : 0;
-        $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
-            ? $this->_req_data['reg_status_change_form']['REG_ID']
-            : $reg_id;
-        $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
-            ? $this->_req_data['ATT_ID'] : 0;
-        $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
-            ? $this->_req_data['post']
-            : $att_id;
-        $this->_page_routes = array(
-            'default'                             => array(
-                'func'       => '_registrations_overview_list_table',
-                'capability' => 'ee_read_registrations',
-            ),
-            'view_registration'                   => array(
-                'func'       => '_registration_details',
-                'capability' => 'ee_read_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'edit_registration'                   => array(
-                'func'               => '_update_attendee_registration_form',
-                'noheader'           => true,
-                'headers_sent_route' => 'view_registration',
-                'capability'         => 'ee_edit_registration',
-                'obj_id'             => $reg_id,
-                '_REG_ID'            => $reg_id,
-            ),
-            'trash_registrations'                 => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'restore_registrations'               => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'delete_registrations'                => array(
-                'func'       => '_delete_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'new_registration'                    => array(
-                'func'       => 'new_registration',
-                'capability' => 'ee_edit_registrations',
-            ),
-            'process_reg_step'                    => array(
-                'func'       => 'process_reg_step',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'redirect_to_txn'                     => array(
-                'func'       => 'redirect_to_txn',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'change_reg_status'                   => array(
-                'func'       => '_change_reg_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registration'                => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_and_notify_registration'     => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('approve'),
-            ),
-            'approve_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('approve', true),
-            ),
-            'decline_registration'                => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_and_notify_registration'     => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('decline'),
-            ),
-            'decline_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('decline', true),
-            ),
-            'pending_registration'                => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_and_notify_registration'     => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('pending'),
-            ),
-            'pending_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('pending', true),
-            ),
-            'no_approve_registration'             => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_and_notify_registration'  => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_registrations'            => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('not_approve'),
-            ),
-            'no_approve_and_notify_registrations' => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('not_approve', true),
-            ),
-            'cancel_registration'                 => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_and_notify_registration'      => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_registrations'                => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('cancel'),
-            ),
-            'cancel_and_notify_registrations'     => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => array('cancel', true),
-            ),
-            'wait_list_registration'              => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'wait_list_and_notify_registration'   => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'contact_list'                        => array(
-                'func'       => '_attendee_contact_list_table',
-                'capability' => 'ee_read_contacts',
-            ),
-            'add_new_attendee'                    => array(
-                'func' => '_create_new_cpt_item',
-                'args' => array(
-                    'new_attendee' => true,
-                    'capability'   => 'ee_edit_contacts',
-                ),
-            ),
-            'edit_attendee'                       => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'duplicate_attendee'                  => array(
-                'func'       => '_duplicate_attendee',
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'insert_attendee'                     => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-            ),
-            'update_attendee'                     => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'trash_attendees'                     => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => 'true',
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-            ),
-            'trash_attendee'                      => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'restore_attendees'                   => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'resend_registration'                 => array(
-                'func'       => '_resend_registration',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'registrations_report'                => array(
-                'func'       => '_registrations_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-            'contact_list_export'                 => array(
-                'func'       => '_contact_list_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ),
-            'contact_list_report'                 => array(
-                'func'       => '_contact_list_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_contacts',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'           => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 5,
-                ),
-                'help_tabs'     => array(
-                    'registrations_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
-                        'filename' => 'registrations_overview',
-                    ),
-                    'registrations_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_overview_table_column_headings',
-                    ),
-                    'registrations_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
-                        'filename' => 'registrations_overview_filters',
-                    ),
-                    'registrations_overview_views_help_tab'                 => array(
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
-                        'filename' => 'registrations_overview_views',
-                    ),
-                    'registrations_regoverview_other_help_tab'              => array(
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
-                        'filename' => 'registrations_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Registrations_List_Table',
-                'require_nonce' => false,
-            ),
-            'view_registration' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
-                    'order'      => 15,
-                    'url'        => isset($this->_req_data['_REG_ID'])
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'registrations_details_help_tab'                    => array(
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
-                        'filename' => 'registrations_details',
-                    ),
-                    'registrations_details_table_help_tab'              => array(
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
-                        'filename' => 'registrations_details_table',
-                    ),
-                    'registrations_details_form_answers_help_tab'       => array(
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
-                        'filename' => 'registrations_details_form_answers',
-                    ),
-                    'registrations_details_registrant_details_help_tab' => array(
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
-                        'filename' => 'registrations_details_registrant_details',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Details_Help_Tour'),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_registration_details_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'new_registration'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
-                    'url'        => '#',
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'labels'        => array(
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
-                ),
-                'require_nonce' => false,
-            ),
-            'add_new_attendee'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_publish_post_box', 'attendee_editor_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'edit_attendee'     => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['ATT_ID'])
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('attendee_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'contact_list'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Contact List', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
-                'help_tabs'     => array(
-                    'registrations_contact_list_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
-                        'filename' => 'registrations_contact_list',
-                    ),
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_table_column_headings',
-                    ),
-                    'registrations_contact_list_views_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_views',
-                    ),
-                    'registrations_contact_list_other_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_other',
-                    ),
-                ),
-                'help_tour'     => array('Contact_List_Help_Tour'),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            // override default cpt routes
-            'create_new'        => '',
-            'edit'              => '',
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
-            'click "Update Registration Questions" to save your changes',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array()
-    {
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_contact_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // style
-        wp_register_style(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_reg');
-        // script
-        wp_register_script(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_reg');
-    }
-
-
-    public function load_scripts_styles_edit_attendee()
-    {
-        // stuff to only show up on our attendee edit details page.
-        $attendee_details_translations = array(
-            'att_publish_text' => sprintf(
-                esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
-                $this->_cpt_model_obj->get_datetime('ATT_created')
-            ),
-        );
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
-        wp_enqueue_script('jquery-validate');
-    }
-
-
-    public function load_scripts_styles_view_registration()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
-    }
-
-
-    public function load_scripts_styles_contact_list()
-    {
-        wp_dequeue_style('espresso_reg');
-        wp_register_style(
-            'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_att');
-    }
-
-
-    public function load_scripts_styles_new_registration()
-    {
-        wp_register_script(
-            'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
-            array('underscore', 'jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-spco-for-admin');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        EE_Form_Section_Proper::wp_enqueue_scripts();
-        EED_Ticket_Selector::load_tckt_slctr_assets();
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        // for notification related bulk actions we need to make sure only active messengers have an option.
-        EED_Messages::set_autoloaders();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts = $message_resource_manager->list_of_active_message_types();
-        // key= bulk_action_slug, value= message type.
-        $match_array = array(
-            'approve_registrations'    => 'registration',
-            'decline_registrations'    => 'declined_registration',
-            'pending_registrations'    => 'pending_approval',
-            'no_approve_registrations' => 'not_approved_registration',
-            'cancel_registrations'     => 'cancelled_registration',
-        );
-        $can_send = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'batch_send_messages'
-        );
-        /** setup reg status bulk actions **/
-        $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
-                'Approve and Notify Registrations',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
-                'Decline and Notify Registrations',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['pending_registrations'] = esc_html__(
-            'Set Registrations to Pending Payment',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
-                'Set Registrations to Pending Payment and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['no_approve_registrations'] = esc_html__(
-            'Set Registrations to Not Approved',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
-                'Set Registrations to Not Approved and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
-                'Cancel Registrations and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
-            $def_reg_status_actions,
-            $active_mts,
-            $can_send
-        );
-
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    array(
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    )
-                ),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    array(
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    )
-                ),
-            ),
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => sprintf(
-                    esc_html__('Today - %s', 'event_espresso'),
-                    date('M d, Y', current_time('timestamp'))
-                ),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    array(
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    )
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_registrations',
-            'espresso_registrations_delete_registration'
-        )) {
-            $this->_views['incomplete'] = array(
-                'slug'        => 'incomplete',
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                ),
-            );
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_contact_list()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => esc_html__('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_contacts',
-            'espresso_registrations_trash_attendees'
-        )
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _registration_legend_items()
-    {
-        $fc_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-clipboard',
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-            ),
-            'edit_attendee'    => array(
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
-            ),
-            'view_transaction' => array(
-                'class' => 'dashicons dashicons-cart',
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-            ),
-            'view_invoice'     => array(
-                'class' => 'dashicons dashicons-media-spreadsheet',
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_resend_registration'
-        )) {
-            $fc_items['resend_registration'] = array(
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
-            );
-        } else {
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $fc_items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        $sc_items = array(
-            'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_pending_payment,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_wait_list,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_incomplete,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_not_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_declined,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_cancelled,
-                    false,
-                    'sentence'
-                ),
-            ),
-        );
-        return array_merge($fc_items, $sc_items);
-    }
-
-
-
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
-    /**
-     * @throws \EE_Error
-     */
-    protected function _registrations_overview_list_table()
-    {
-        $this->_template_args['admin_page_header'] = '';
-        $EVT_ID = ! empty($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : 0;
-        $ATT_ID = ! empty($this->_req_data['ATT_ID'])
-            ? absint($this->_req_data['ATT_ID'])
-            : 0;
-        if ($ATT_ID) {
-            $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID);
-            if ($attendee instanceof EE_Attendee) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%1$s Viewing registrations for %2$s%3$s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_attendee',
-                            'post'   => $ATT_ID,
-                        ),
-                        REG_ADMIN_URL
-                    ) . '">' . $attendee->full_name() . '</a>',
-                    '</h3>'
-                );
-            }
-        }
-        if ($EVT_ID) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $EVT_ID
-            )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                    'new_registration',
-                    'add-registrant',
-                    array('event_id' => $EVT_ID),
-                    'add-new-h2'
-                );
-            }
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            if ($event instanceof EE_Event) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%s Viewing registrations for the event: %s%s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<br /><a href="'
-                    . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit',
-                            'post'   => $event->ID(),
-                        ),
-                        EVENTS_ADMIN_URL
-                    )
-                    . '">&nbsp;'
-                    . $event->get('EVT_name')
-                    . '&nbsp;</a>&nbsp;',
-                    '</h3>'
-                );
-            }
-            $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
-                $this->_template_args['admin_page_header'] = substr(
-                    $this->_template_args['admin_page_header'],
-                    0,
-                    -5
-                );
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
-                $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
-            }
-        }
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * This sets the _registration property for the registration details screen
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_registration_object()
-    {
-        // get out if we've already set the object
-        if ($this->_registration instanceof EE_Registration) {
-            return true;
-        }
-        $REG = EEM_Registration::instance();
-        $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
-            return true;
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for Registration ID #%s could not be retrieved.',
-                    'event_espresso'
-                ),
-                $REG_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_registration = null;
-            return false;
-        }
-    }
-
-
-    /**
-     * Used to retrieve registrations for the list table.
-     *
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $this_month
-     * @param bool $today
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_registrations(
-        $per_page = 10,
-        $count = false,
-        $this_month = false,
-        $today = false
-    ) {
-        if ($this_month) {
-            $this->_req_data['status'] = 'month';
-        }
-        if ($today) {
-            $this->_req_data['status'] = 'today';
-        }
-        $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         *
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         *                             or if you have the development copy of EE you can view this at the path:
-         *                             /docs/G--Model-System/model-query-params.md
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
-     * Note: this listens to values on the request for some of the query parameters.
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_registration_query_parameters(
-        $request = array(),
-        $per_page = 10,
-        $count = false
-    ) {
-
-        $query_params = array(
-            0                          => $this->_get_where_conditions_for_registrations_query(
-                $request
-            ),
-            'caps'                     => EEM_Registration::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        );
-        if (! $count) {
-            $query_params = array_merge(
-                $query_params,
-                $this->_get_orderby_for_registrations_query(),
-                $this->_get_limit($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * This will add ATT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function addAttendeeIdToWhereConditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['ATT_ID'])) {
-            $where['ATT_ID'] = absint($request['ATT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_event_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['event_id'])) {
-            $where['EVT_ID'] = absint($request['event_id']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_category_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
-            $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_datetime_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['datetime_id'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
-        }
-        if (! empty($request['DTT_ID'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_registration_status_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $registration_status = ! empty($request['_reg_status'])
-            ? sanitize_text_field($request['_reg_status'])
-            : '';
-
-        /*
+	/**
+	 * @var EE_Registration
+	 */
+	private $_registration;
+
+	/**
+	 * @var EE_Event
+	 */
+	private $_reg_event;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	private static $_reg_status;
+
+	/**
+	 * Form for displaying the custom questions for this registration.
+	 * This gets used a few times throughout the request so its best to cache it
+	 *
+	 * @var EE_Registration_Custom_Questions_Form
+	 */
+	protected $_reg_custom_questions_form = null;
+
+
+	/**
+	 *        constructor
+	 *
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @return Registrations_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		add_action('wp_loaded', array($this, 'wp_loaded'));
+	}
+
+
+	public function wp_loaded()
+	{
+		// when adding a new registration...
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
+			EE_System::do_not_cache();
+			if (! isset($this->_req_data['processing_registration'])
+				|| absint($this->_req_data['processing_registration']) !== 1
+			) {
+				// and it's NOT the attendee information reg step
+				// force cookie expiration by setting time to last week
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
+				// and update the global
+				$_COOKIE['ee_registration_added'] = 0;
+			}
+		}
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = REG_PG_SLUG;
+		$this->_admin_base_url = REG_ADMIN_URL;
+		$this->_admin_base_path = REG_ADMIN;
+		$this->page_label = esc_html__('Registrations', 'event_espresso');
+		$this->_cpt_routes = array(
+			'add_new_attendee' => 'espresso_attendees',
+			'edit_attendee'    => 'espresso_attendees',
+			'insert_attendee'  => 'espresso_attendees',
+			'update_attendee'  => 'espresso_attendees',
+		);
+		$this->_cpt_model_names = array(
+			'add_new_attendee' => 'EEM_Attendee',
+			'edit_attendee'    => 'EEM_Attendee',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_attendees' => 'edit_attendee',
+		);
+		$this->_pagenow_map = array(
+			'add_new_attendee' => 'post-new.php',
+			'edit_attendee'    => 'post.php',
+			'trash'            => 'post.php',
+		);
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
+		// add filters so that the comment urls don't take users to a confusing 404 page
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
+	}
+
+
+	public function clear_comment_link($link, $comment, $args)
+	{
+		// gotta make sure this only happens on this route
+		$post_type = get_post_type($comment->comment_post_ID);
+		if ($post_type === 'espresso_attendees') {
+			return '#commentsdiv';
+		}
+		return $link;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for registrations ajax goes in here
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'buttons'                      => array(
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
+				'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
+				'contact_list_export' => esc_html__("Export Data", "event_espresso"),
+			),
+			'publishbox'                   => array(
+				'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
+				'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
+			),
+			'hide_add_button_on_cpt_route' => array(
+				'edit_attendee' => true,
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function _set_page_routes()
+	{
+		$this->_get_registration_status_array();
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID'] : 0;
+		$reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
+			? $this->_req_data['reg_status_change_form']['REG_ID']
+			: $reg_id;
+		$att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
+			? $this->_req_data['ATT_ID'] : 0;
+		$att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
+			? $this->_req_data['post']
+			: $att_id;
+		$this->_page_routes = array(
+			'default'                             => array(
+				'func'       => '_registrations_overview_list_table',
+				'capability' => 'ee_read_registrations',
+			),
+			'view_registration'                   => array(
+				'func'       => '_registration_details',
+				'capability' => 'ee_read_registration',
+				'obj_id'     => $reg_id,
+			),
+			'edit_registration'                   => array(
+				'func'               => '_update_attendee_registration_form',
+				'noheader'           => true,
+				'headers_sent_route' => 'view_registration',
+				'capability'         => 'ee_edit_registration',
+				'obj_id'             => $reg_id,
+				'_REG_ID'            => $reg_id,
+			),
+			'trash_registrations'                 => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'restore_registrations'               => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'delete_registrations'                => array(
+				'func'       => '_delete_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'new_registration'                    => array(
+				'func'       => 'new_registration',
+				'capability' => 'ee_edit_registrations',
+			),
+			'process_reg_step'                    => array(
+				'func'       => 'process_reg_step',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'redirect_to_txn'                     => array(
+				'func'       => 'redirect_to_txn',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'change_reg_status'                   => array(
+				'func'       => '_change_reg_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registration'                => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_and_notify_registration'     => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('approve'),
+			),
+			'approve_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('approve', true),
+			),
+			'decline_registration'                => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_and_notify_registration'     => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('decline'),
+			),
+			'decline_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('decline', true),
+			),
+			'pending_registration'                => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_and_notify_registration'     => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('pending'),
+			),
+			'pending_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('pending', true),
+			),
+			'no_approve_registration'             => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_and_notify_registration'  => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_registrations'            => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('not_approve'),
+			),
+			'no_approve_and_notify_registrations' => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('not_approve', true),
+			),
+			'cancel_registration'                 => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_and_notify_registration'      => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_registrations'                => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('cancel'),
+			),
+			'cancel_and_notify_registrations'     => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => array('cancel', true),
+			),
+			'wait_list_registration'              => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'wait_list_and_notify_registration'   => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'contact_list'                        => array(
+				'func'       => '_attendee_contact_list_table',
+				'capability' => 'ee_read_contacts',
+			),
+			'add_new_attendee'                    => array(
+				'func' => '_create_new_cpt_item',
+				'args' => array(
+					'new_attendee' => true,
+					'capability'   => 'ee_edit_contacts',
+				),
+			),
+			'edit_attendee'                       => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'duplicate_attendee'                  => array(
+				'func'       => '_duplicate_attendee',
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'insert_attendee'                     => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+			),
+			'update_attendee'                     => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'trash_attendees'                     => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => 'true',
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+			),
+			'trash_attendee'                      => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'restore_attendees'                   => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'resend_registration'                 => array(
+				'func'       => '_resend_registration',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'registrations_report'                => array(
+				'func'       => '_registrations_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+			'contact_list_export'                 => array(
+				'func'       => '_contact_list_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			),
+			'contact_list_report'                 => array(
+				'func'       => '_contact_list_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_contacts',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'           => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 5,
+				),
+				'help_tabs'     => array(
+					'registrations_overview_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
+						'filename' => 'registrations_overview',
+					),
+					'registrations_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_overview_table_column_headings',
+					),
+					'registrations_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
+						'filename' => 'registrations_overview_filters',
+					),
+					'registrations_overview_views_help_tab'                 => array(
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
+						'filename' => 'registrations_overview_views',
+					),
+					'registrations_regoverview_other_help_tab'              => array(
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
+						'filename' => 'registrations_overview_other',
+					),
+				),
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Registrations_List_Table',
+				'require_nonce' => false,
+			),
+			'view_registration' => array(
+				'nav'           => array(
+					'label'      => esc_html__('REG Details', 'event_espresso'),
+					'order'      => 15,
+					'url'        => isset($this->_req_data['_REG_ID'])
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'registrations_details_help_tab'                    => array(
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
+						'filename' => 'registrations_details',
+					),
+					'registrations_details_table_help_tab'              => array(
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
+						'filename' => 'registrations_details_table',
+					),
+					'registrations_details_form_answers_help_tab'       => array(
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
+						'filename' => 'registrations_details_form_answers',
+					),
+					'registrations_details_registrant_details_help_tab' => array(
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
+						'filename' => 'registrations_details_registrant_details',
+					),
+				),
+				'help_tour'     => array('Registration_Details_Help_Tour'),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_registration_details_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'new_registration'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
+					'url'        => '#',
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'labels'        => array(
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
+				),
+				'require_nonce' => false,
+			),
+			'add_new_attendee'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_publish_post_box', 'attendee_editor_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'edit_attendee'     => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['ATT_ID'])
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('attendee_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'contact_list'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Contact List', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
+				'help_tabs'     => array(
+					'registrations_contact_list_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
+						'filename' => 'registrations_contact_list',
+					),
+					'registrations_contact-list_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_contact_list_table_column_headings',
+					),
+					'registrations_contact_list_views_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
+						'filename' => 'registrations_contact_list_views',
+					),
+					'registrations_contact_list_other_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
+						'filename' => 'registrations_contact_list_other',
+					),
+				),
+				'help_tour'     => array('Contact_List_Help_Tour'),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			// override default cpt routes
+			'create_new'        => '',
+			'edit'              => '',
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
+			'click "Update Registration Questions" to save your changes',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array()
+	{
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_contact_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// style
+		wp_register_style(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_reg');
+		// script
+		wp_register_script(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_reg');
+	}
+
+
+	public function load_scripts_styles_edit_attendee()
+	{
+		// stuff to only show up on our attendee edit details page.
+		$attendee_details_translations = array(
+			'att_publish_text' => sprintf(
+				esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
+				$this->_cpt_model_obj->get_datetime('ATT_created')
+			),
+		);
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
+		wp_enqueue_script('jquery-validate');
+	}
+
+
+	public function load_scripts_styles_view_registration()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
+	}
+
+
+	public function load_scripts_styles_contact_list()
+	{
+		wp_dequeue_style('espresso_reg');
+		wp_register_style(
+			'espresso_att',
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_att');
+	}
+
+
+	public function load_scripts_styles_new_registration()
+	{
+		wp_register_script(
+			'ee-spco-for-admin',
+			REG_ASSETS_URL . 'spco_for_admin.js',
+			array('underscore', 'jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-spco-for-admin');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		EE_Form_Section_Proper::wp_enqueue_scripts();
+		EED_Ticket_Selector::load_tckt_slctr_assets();
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		// for notification related bulk actions we need to make sure only active messengers have an option.
+		EED_Messages::set_autoloaders();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts = $message_resource_manager->list_of_active_message_types();
+		// key= bulk_action_slug, value= message type.
+		$match_array = array(
+			'approve_registrations'    => 'registration',
+			'decline_registrations'    => 'declined_registration',
+			'pending_registrations'    => 'pending_approval',
+			'no_approve_registrations' => 'not_approved_registration',
+			'cancel_registrations'     => 'cancelled_registration',
+		);
+		$can_send = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'batch_send_messages'
+		);
+		/** setup reg status bulk actions **/
+		$def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
+				'Approve and Notify Registrations',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
+				'Decline and Notify Registrations',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['pending_registrations'] = esc_html__(
+			'Set Registrations to Pending Payment',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
+				'Set Registrations to Pending Payment and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['no_approve_registrations'] = esc_html__(
+			'Set Registrations to Not Approved',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
+				'Set Registrations to Not Approved and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
+				'Cancel Registrations and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
+			$def_reg_status_actions,
+			$active_mts,
+			$can_send
+		);
+
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					array(
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					)
+				),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					array(
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					)
+				),
+			),
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => sprintf(
+					esc_html__('Today - %s', 'event_espresso'),
+					date('M d, Y', current_time('timestamp'))
+				),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					array(
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					)
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_registrations',
+			'espresso_registrations_delete_registration'
+		)) {
+			$this->_views['incomplete'] = array(
+				'slug'        => 'incomplete',
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				),
+			);
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_contact_list()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => esc_html__('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_contacts',
+			'espresso_registrations_trash_attendees'
+		)
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _registration_legend_items()
+	{
+		$fc_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-clipboard',
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+			),
+			'edit_attendee'    => array(
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
+			),
+			'view_transaction' => array(
+				'class' => 'dashicons dashicons-cart',
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+			),
+			'view_invoice'     => array(
+				'class' => 'dashicons dashicons-media-spreadsheet',
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_resend_registration'
+		)) {
+			$fc_items['resend_registration'] = array(
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
+			);
+		} else {
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$fc_items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		$sc_items = array(
+			'approved_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_approved,
+					false,
+					'sentence'
+				),
+			),
+			'pending_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_pending_payment,
+					false,
+					'sentence'
+				),
+			),
+			'wait_list'         => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_wait_list,
+					false,
+					'sentence'
+				),
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_incomplete,
+					false,
+					'sentence'
+				),
+			),
+			'not_approved'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_not_approved,
+					false,
+					'sentence'
+				),
+			),
+			'declined_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_declined,
+					false,
+					'sentence'
+				),
+			),
+			'cancelled_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_cancelled,
+					false,
+					'sentence'
+				),
+			),
+		);
+		return array_merge($fc_items, $sc_items);
+	}
+
+
+
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
+	/**
+	 * @throws \EE_Error
+	 */
+	protected function _registrations_overview_list_table()
+	{
+		$this->_template_args['admin_page_header'] = '';
+		$EVT_ID = ! empty($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: 0;
+		$ATT_ID = ! empty($this->_req_data['ATT_ID'])
+			? absint($this->_req_data['ATT_ID'])
+			: 0;
+		if ($ATT_ID) {
+			$attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID);
+			if ($attendee instanceof EE_Attendee) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%1$s Viewing registrations for %2$s%3$s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_attendee',
+							'post'   => $ATT_ID,
+						),
+						REG_ADMIN_URL
+					) . '">' . $attendee->full_name() . '</a>',
+					'</h3>'
+				);
+			}
+		}
+		if ($EVT_ID) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$EVT_ID
+			)) {
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+					'new_registration',
+					'add-registrant',
+					array('event_id' => $EVT_ID),
+					'add-new-h2'
+				);
+			}
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			if ($event instanceof EE_Event) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%s Viewing registrations for the event: %s%s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<br /><a href="'
+					. EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit',
+							'post'   => $event->ID(),
+						),
+						EVENTS_ADMIN_URL
+					)
+					. '">&nbsp;'
+					. $event->get('EVT_name')
+					. '&nbsp;</a>&nbsp;',
+					'</h3>'
+				);
+			}
+			$DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
+				$this->_template_args['admin_page_header'] = substr(
+					$this->_template_args['admin_page_header'],
+					0,
+					-5
+				);
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
+				$this->_template_args['admin_page_header'] .= $datetime->name();
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
+			}
+		}
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * This sets the _registration property for the registration details screen
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_registration_object()
+	{
+		// get out if we've already set the object
+		if ($this->_registration instanceof EE_Registration) {
+			return true;
+		}
+		$REG = EEM_Registration::instance();
+		$REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
+			return true;
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for Registration ID #%s could not be retrieved.',
+					'event_espresso'
+				),
+				$REG_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_registration = null;
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used to retrieve registrations for the list table.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $this_month
+	 * @param bool $today
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_registrations(
+		$per_page = 10,
+		$count = false,
+		$this_month = false,
+		$today = false
+	) {
+		if ($this_month) {
+			$this->_req_data['status'] = 'month';
+		}
+		if ($today) {
+			$this->_req_data['status'] = 'today';
+		}
+		$query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 *
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 *                             or if you have the development copy of EE you can view this at the path:
+		 *                             /docs/G--Model-System/model-query-params.md
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
+	 * Note: this listens to values on the request for some of the query parameters.
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_registration_query_parameters(
+		$request = array(),
+		$per_page = 10,
+		$count = false
+	) {
+
+		$query_params = array(
+			0                          => $this->_get_where_conditions_for_registrations_query(
+				$request
+			),
+			'caps'                     => EEM_Registration::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		);
+		if (! $count) {
+			$query_params = array_merge(
+				$query_params,
+				$this->_get_orderby_for_registrations_query(),
+				$this->_get_limit($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * This will add ATT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function addAttendeeIdToWhereConditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['ATT_ID'])) {
+			$where['ATT_ID'] = absint($request['ATT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_event_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['event_id'])) {
+			$where['EVT_ID'] = absint($request['event_id']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_category_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
+			$where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_datetime_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['datetime_id'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
+		}
+		if (! empty($request['DTT_ID'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_registration_status_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$registration_status = ! empty($request['_reg_status'])
+			? sanitize_text_field($request['_reg_status'])
+			: '';
+
+		/*
          * If filtering by registration status, then we show registrations matching that status.
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
-            $where['STS_ID'] = $registration_status;
-        } else {
-            // make sure we exclude incomplete registrations, but only if not trashed.
-            if ($view === 'trash') {
-                $where['REG_deleted'] = true;
-            } elseif ($view === 'incomplete') {
-                $where['STS_ID'] = EEM_Registration::status_id_incomplete;
-            } else {
-                $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_date_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $month_range = ! empty($request['month_range'])
-            ? sanitize_text_field($request['month_range'])
-            : '';
-        $retrieve_for_today = $view === 'today';
-        $retrieve_for_this_month = $view === 'month';
-
-        if ($retrieve_for_today) {
-            $now = date('Y-m-d', current_time('timestamp'));
-            $where['REG_date'] = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($retrieve_for_this_month) {
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
-            $days_this_month = date('t', current_time('timestamp'));
-            $where['REG_date'] = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($month_range) {
-            $pieces = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            // if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $where['REG_date'] = array(
-                    'BETWEEN',
-                    array(
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s'
-                        ),
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s'
-                        ),
-                    ),
-                );
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_search_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
-            $where['OR*search_conditions'] = array(
-                'Event.EVT_name'                          => array('LIKE', $search_string),
-                'Event.EVT_desc'                          => array('LIKE', $search_string),
-                'Event.EVT_short_desc'                    => array('LIKE', $search_string),
-                'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
-                'Attendee.ATT_fname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_lname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
-                'Attendee.ATT_email'                      => array('LIKE', $search_string),
-                'Attendee.ATT_address'                    => array('LIKE', $search_string),
-                'Attendee.ATT_address2'                   => array('LIKE', $search_string),
-                'Attendee.ATT_city'                       => array('LIKE', $search_string),
-                'REG_final_price'                         => array('LIKE', $search_string),
-                'REG_code'                                => array('LIKE', $search_string),
-                'REG_count'                               => array('LIKE', $search_string),
-                'REG_group_size'                          => array('LIKE', $search_string),
-                'Ticket.TKT_name'                         => array('LIKE', $search_string),
-                'Ticket.TKT_description'                  => array('LIKE', $search_string),
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
-            );
-        }
-        return $where;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param array $request
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_where_conditions_for_registrations_query($request)
-    {
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            array_merge(
-                $this->addAttendeeIdToWhereConditions($request),
-                $this->_add_event_id_to_where_conditions($request),
-                $this->_add_category_id_to_where_conditions($request),
-                $this->_add_datetime_id_to_where_conditions($request),
-                $this->_add_registration_status_to_where_conditions($request),
-                $this->_add_date_to_where_conditions($request),
-                $this->_add_search_to_where_conditions($request)
-            ),
-            $request
-        );
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function _get_orderby_for_registrations_query()
-    {
-        $orderby_field = ! empty($this->_req_data['orderby'])
-            ? sanitize_text_field($this->_req_data['orderby'])
-            : '_REG_date';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby = array('REG_ID');
-                break;
-            case '_Reg_status':
-                $orderby = array('STS_ID');
-                break;
-            case 'ATT_fname':
-                $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
-                break;
-            case 'ATT_lname':
-                $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
-                break;
-            case 'event_name':
-                $orderby = array('Event.EVT_name');
-                break;
-            case 'DTT_EVT_start':
-                $orderby = array('Event.Datetime.DTT_EVT_start');
-                break;
-            case '_REG_date':
-                $orderby = array('REG_date');
-                break;
-            default:
-                $orderby = array($orderby_field);
-                break;
-        }
-
-        // order
-        $order = ! empty($this->_req_data['order'])
-            ? sanitize_text_field($this->_req_data['order'])
-            : 'DESC';
-        $orderby = array_combine(
-            $orderby,
-            array_fill(0, count($orderby), $order)
-        );
-        // because there are many registrations with the same date, define
-        // a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($orderby['REG_ID'])) {
-            $orderby['REG_ID'] = $order;
-        }
-
-        $orderby = apply_filters(
-            'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
-            $orderby,
-            $this->_req_data
-        );
-
-        return array('order_by' => $orderby);
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param $per_page
-     * @return array
-     */
-    protected function _get_limit($per_page)
-    {
-        $current_page = ! empty($this->_req_data['paged'])
-            ? absint($this->_req_data['paged'])
-            : 1;
-        $per_page = ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-
-        // -1 means return all results so get out if that's set.
-        if ((int) $per_page === -1) {
-            return array();
-        }
-        $per_page = absint($per_page);
-        $offset = ($current_page - 1) * $per_page;
-        return array('limit' => array($offset, $per_page));
-    }
-
-
-    public function get_registration_status_array()
-    {
-        return self::$_reg_status;
-    }
-
-
-
-
-    /***************************************        REGISTRATION DETAILS        ***************************************/
-    /**
-     *        generates HTML for the View Registration Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     */
-    protected function _registration_details()
-    {
-        $this->_template_args = array();
-        $this->_set_registration_object();
-        if (is_object($this->_registration)) {
-            $transaction = $this->_registration->transaction()
-                ? $this->_registration->transaction()
-                : EE_Transaction::new_instance();
-            $this->_session = $transaction->session_data();
-            $event_id = $this->_registration->event_ID();
-            $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID();
-            $this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso');
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
-            $this->_template_args['grand_total'] = $transaction->total();
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-            // link back to overview
-            $this->_template_args['reg_overview_url'] = REG_ADMIN_URL;
-            $this->_template_args['registration'] = $this->_registration;
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'default',
-                    'event_id' => $event_id,
-                ),
-                REG_ADMIN_URL
-            );
-            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event_id,
-                    'page'   => 'espresso_transactions',
-                ),
-                admin_url('admin.php')
-            );
-            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_events',
-                    'action' => 'edit',
-                    'post'   => $event_id,
-                ),
-                admin_url('admin.php')
-            );
-            // next and previous links
-            $next_reg = $this->_registration->next(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['next_registration'] = $next_reg
-                ? $this->_next_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $next_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
-                )
-                : '';
-            $previous_reg = $this->_registration->previous(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['previous_registration'] = $previous_reg
-                ? $this->_previous_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $previous_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
-                )
-                : '';
-            // grab header
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
-            $this->_template_args['REG_ID'] = $this->_registration->ID();
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-        } else {
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
-        }
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _registration_details_metaboxes()
-    {
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
-        $this->_set_registration_object();
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
-        add_meta_box(
-            'edit-reg-status-mbox',
-            esc_html__('Registration Status', 'event_espresso'),
-            array($this, 'set_reg_status_buttons_metabox'),
-            $this->wp_page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'edit-reg-details-mbox',
-            esc_html__('Registration Details', 'event_espresso'),
-            array($this, '_reg_details_meta_box'),
-            $this->wp_page_slug,
-            'normal',
-            'high'
-        );
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'edit-reg-questions-mbox',
-                $this->_registration->ID()
-            )
-        ) {
-            add_meta_box(
-                'edit-reg-questions-mbox',
-                esc_html__('Registration Form Answers', 'event_espresso'),
-                array($this, '_reg_questions_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-        add_meta_box(
-            'edit-reg-registrant-mbox',
-            esc_html__('Contact Details', 'event_espresso'),
-            array($this, '_reg_registrant_side_meta_box'),
-            $this->wp_page_slug,
-            'side',
-            'high'
-        );
-        if ($this->_registration->group_size() > 1) {
-            add_meta_box(
-                'edit-reg-attendees-mbox',
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
-                array($this, '_reg_attendees_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-    }
-
-
-    /**
-     * set_reg_status_buttons_metabox
-     *
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    public function set_reg_status_buttons_metabox()
-    {
-        $this->_set_registration_object();
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
-        echo $change_reg_status_form->form_open(
-            self::add_query_args_and_nonce(
-                array(
-                    'action' => 'change_reg_status',
-                ),
-                REG_ADMIN_URL
-            )
-        );
-        echo $change_reg_status_form->get_html();
-        echo $change_reg_status_form->form_close();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _generate_reg_status_change_form()
-    {
-        $reg_status_change_form_array = array(
-            'name'            => 'reg_status_change_form',
-            'html_id'         => 'reg-status-change-form',
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-            'subsections'     => array(
-                'return'             => new EE_Hidden_Input(
-                    array(
-                        'name'    => 'return',
-                        'default' => 'view_registration',
-                    )
-                ),
-                'REG_ID'             => new EE_Hidden_Input(
-                    array(
-                        'name'    => 'REG_ID',
-                        'default' => $this->_registration->ID(),
-                    )
-                ),
-                'current_status'     => new EE_Form_Section_HTML(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(
-                                    esc_html__('Current Registration Status', 'event_espresso')
-                                )
-                            )
-                        )
-                        . EEH_HTML::td(
-                            EEH_HTML::strong(
-                                $this->_registration->pretty_status(),
-                                '',
-                                'status-' . $this->_registration->status_ID(),
-                                'line-height: 1em; font-size: 1.5em; font-weight: bold;'
-                            )
-                        )
-                    )
-                )
-            )
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_registration',
-            'toggle_registration_status',
-            $this->_registration->ID()
-        )) {
-            $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input(
-                $this->_get_reg_statuses(),
-                array(
-                    'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
-                    'default'         => $this->_registration->status_ID(),
-                )
-            );
-            $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input(
-                array(
-                    'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
-                    'default'         => false,
-                    'html_help_text'  => esc_html__(
-                        'If set to "Yes", then the related messages will be sent to the registrant.',
-                        'event_espresso'
-                    )
-                )
-            );
-            $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input(
-                array(
-                    'html_class'      => 'button-primary',
-                    'html_label_text' => '&nbsp;',
-                    'default'         => esc_html__('Update Registration Status', 'event_espresso'),
-                )
-            );
-        }
-        return new EE_Form_Section_Proper($reg_status_change_form_array);
-    }
-
-
-    /**
-     * Returns an array of all the buttons for the various statuses and switch status actions
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     */
-    protected function _get_reg_statuses()
-    {
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
-        unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
-        // get current reg status
-        $current_status = $this->_registration->status_ID();
-        // is registration for free event? This will determine whether to display the pending payment option
-        if ($current_status !== EEM_Registration::status_id_pending_payment
-            && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
-        ) {
-            unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
-        }
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
-    }
-
-
-    /**
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
-     *
-     * @param bool $status REG status given for changing registrations to.
-     * @param bool $notify Whether to send messages notifications or not.
-     * @return array (array with reg_id(s) updated and whether update was successful.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    protected function _set_registration_status_from_request($status = false, $notify = false)
-    {
-        if (isset($this->_req_data['reg_status_change_form'])) {
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
-                ? (array) $this->_req_data['reg_status_change_form']['REG_ID']
-                : array();
-        } else {
-            $REG_IDs = isset($this->_req_data['_REG_ID'])
-                ? (array) $this->_req_data['_REG_ID']
-                : array();
-        }
-        // sanitize $REG_IDs
-        $REG_IDs = array_map('absint', $REG_IDs);
-        // and remove empty entries
-        $REG_IDs = array_filter($REG_IDs);
-
-        $result = $this->_set_registration_status($REG_IDs, $status, $notify);
-
-        /**
-         * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
-         * Currently this value is used downstream by the _process_resend_registration method.
-         *
-         * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
-         * @param bool                     $status           The status registrations were changed to.
-         * @param bool                     $success          If the status was changed successfully for all registrations.
-         * @param Registrations_Admin_Page $admin_page_object
-         */
-        $this->_req_data['_REG_ID'] = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
-            $result['REG_ID'],
-            $status,
-            $result['success'],
-            $this
-        );
-
-        // notify?
-        if ($notify
-            && $result['success']
-            && ! empty($this->_req_data['_REG_ID'])
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $result;
-    }
-
-
-    /**
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
-     *
-     * @param array  $REG_IDs
-     * @param string $status
-     * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
-     *                        slug sent with setting the registration status.
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false)
-    {
-        $success = false;
-        // typecast $REG_IDs
-        $REG_IDs = (array) $REG_IDs;
-        if (! empty($REG_IDs)) {
-            $success = true;
-            // set default status if none is passed
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
-            $status_context = $notify
-                ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-                : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
-            // loop through REG_ID's and change status
-            foreach ($REG_IDs as $REG_ID) {
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_status(
-                        $status,
-                        false,
-                        new Context(
-                            $status_context,
-                            esc_html__(
-                                'Manually triggered status change on a Registration Admin Page route.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-
-        // return $success and processed registrations
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
-    }
-
-
-    /**
-     * Common logic for setting up success message and redirecting to appropriate route
-     *
-     * @param  string $STS_ID status id for the registration changed to
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _reg_status_change_return($STS_ID, $notify = false)
-    {
-        $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
-            : array('success' => false);
-        $success = isset($result['success']) && $result['success'];
-        // setup success message
-        if ($success) {
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
-                $msg = sprintf(
-                    esc_html__('Registration status has been set to %s', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower')
-                );
-            } else {
-                $msg = sprintf(
-                    esc_html__('Registrations have been set to %s.', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower')
-                );
-            }
-            EE_Error::add_success($msg);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong, and the status was not changed',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-        }
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
-        } else {
-            $route = array('action' => 'default');
-        }
-        $route = $this->mergeExistingRequestParamsWithRedirectArgs($route);
-        $this->_redirect_after_action($success, '', '', $route, true);
-    }
-
-
-    /**
-     * incoming reg status change from reg details page.
-     *
-     * @return void
-     */
-    protected function _change_reg_status()
-    {
-        $this->_req_data['return'] = 'view_registration';
-        // set notify based on whether the send notifications toggle is set or not
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
-        // $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
-            case EEM_Registration::status_id_approved:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'):
-                $this->approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_pending_payment:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'):
-                $this->pending_registration($notify);
-                break;
-            case EEM_Registration::status_id_not_approved:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'):
-                $this->not_approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_declined:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'):
-                $this->decline_registration($notify);
-                break;
-            case EEM_Registration::status_id_cancelled:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'):
-                $this->cancel_registration($notify);
-                break;
-            case EEM_Registration::status_id_wait_list:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'):
-                $this->wait_list_registration($notify);
-                break;
-            case EEM_Registration::status_id_incomplete:
-            default:
-                $result['success'] = false;
-                unset($this->_req_data['return']);
-                $this->_reg_status_change_return('', false);
-                break;
-        }
-    }
-
-
-    /**
-     * Callback for bulk action routes.
-     * Note: although we could just register the singular route callbacks for each bulk action route as well, this
-     * method was chosen so there is one central place all the registration status bulk actions are going through.
-     * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
-     * when an action is happening on just a single registration).
-     *
-     * @param      $action
-     * @param bool $notify
-     */
-    protected function bulk_action_on_registrations($action, $notify = false)
-    {
-        do_action(
-            'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
-            $this,
-            $action,
-            $notify
-        );
-        $method = $action . '_registration';
-        if (method_exists($this, $method)) {
-            $this->$method($notify);
-        }
-    }
-
-
-    /**
-     * approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their approval.
-     * @return void
-     */
-    protected function approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function decline_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
-    }
-
-
-    /**
-     *        cancel_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function cancel_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
-    }
-
-
-    /**
-     *        not_approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function not_approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function pending_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
-    }
-
-
-    /**
-     * waitlist_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function wait_list_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public function _reg_details_meta_box()
-    {
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        EEH_Autoloader::register_line_item_filter_autoloaders();
-        EE_Registry::instance()->load_helper('Line_Item');
-        $transaction = $this->_registration->transaction() ? $this->_registration->transaction()
-            : EE_Transaction::new_instance();
-        $this->_session = $transaction->session_data();
-        $filters = new EE_Line_Item_Filter_Collection();
-        // $filters->add( new EE_Non_Zero_Line_Item_Filter() );
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
-        $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
-            $filters,
-            $transaction->total_line_item()
-        );
-        $filtered_line_item_tree = $line_item_filter_processor->process();
-        $line_item_display = new EE_Line_Item_Display(
-            'reg_admin_table',
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
-            $filtered_line_item_tree,
-            array('EE_Registration' => $this->_registration)
-        );
-        $attendee = $this->_registration->attendee();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction'
-        )) {
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' View Transaction', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-cart'
-            );
-        } else {
-            $this->_template_args['view_transaction_button'] = '';
-        }
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'      => 'resend_registration',
-                        '_REG_ID'     => $this->_registration->ID(),
-                        'redirect_to' => 'view_registration',
-                    ),
-                    REG_ADMIN_URL
-                ),
-                esc_html__(' Resend Registration', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-email-alt'
-            );
-        } else {
-            $this->_template_args['resend_registration_button'] = '';
-        }
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        $payment = $transaction->get_first_related('Payment');
-        $payment = ! $payment instanceof EE_Payment
-            ? EE_Payment::new_instance()
-            : $payment;
-        $payment_method = $payment->get_first_related('Payment_Method');
-        $payment_method = ! $payment_method instanceof EE_Payment_Method
-            ? EE_Payment_Method::new_instance()
-            : $payment_method;
-        $reg_details = array(
-            'payment_method'       => $payment_method->name(),
-            'response_msg'         => $payment->gateway_response(),
-            'registration_id'      => $this->_registration->get('REG_code'),
-            'registration_session' => $this->_registration->session_ID(),
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
-        );
-        if (isset($reg_details['registration_id'])) {
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
-                'Registration ID',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
-        }
-        if (isset($reg_details['payment_method'])) {
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
-                'Most Recent Payment Method',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
-            $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg'];
-            $this->_template_args['reg_details']['response_msg']['label'] = esc_html__(
-                'Payment method response',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
-        }
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address'];
-        $this->_template_args['reg_details']['ip_address']['label'] = esc_html__(
-            'Registration placed from IP',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent'];
-        $this->_template_args['reg_details']['user_agent']['label'] = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['user_agent']['class'] = 'large-text';
-        $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'   => 'default',
-                'event_id' => $this->_registration->event_ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $this->_template_args['REG_ID'] = $this->_registration->ID();
-        $this->_template_args['event_id'] = $this->_registration->event_ID();
-        $template_path =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * generates HTML for the Registration Questions meta box.
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
-     * otherwise uses new forms system
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_questions_meta_box()
-    {
-        // allow someone to override this method entirely
-        if (apply_filters(
-            'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-            true,
-            $this,
-            $this->_registration
-        )) {
-            $form = $this->_get_reg_custom_questions_form(
-                $this->_registration->ID()
-            );
-            $this->_template_args['att_questions'] = count($form->subforms()) > 0
-                ? $form->get_html_and_js()
-                : '';
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
-            $this->_template_args['REG_ID'] = $this->_registration->ID();
-            $template_path =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
-        }
-    }
-
-
-    /**
-     * form_before_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_before_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+		if (! empty($registration_status)) {
+			$where['STS_ID'] = $registration_status;
+		} else {
+			// make sure we exclude incomplete registrations, but only if not trashed.
+			if ($view === 'trash') {
+				$where['REG_deleted'] = true;
+			} elseif ($view === 'incomplete') {
+				$where['STS_ID'] = EEM_Registration::status_id_incomplete;
+			} else {
+				$where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_date_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$month_range = ! empty($request['month_range'])
+			? sanitize_text_field($request['month_range'])
+			: '';
+		$retrieve_for_today = $view === 'today';
+		$retrieve_for_this_month = $view === 'month';
+
+		if ($retrieve_for_today) {
+			$now = date('Y-m-d', current_time('timestamp'));
+			$where['REG_date'] = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($retrieve_for_this_month) {
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
+			$days_this_month = date('t', current_time('timestamp'));
+			$where['REG_date'] = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($month_range) {
+			$pieces = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			// if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$where['REG_date'] = array(
+					'BETWEEN',
+					array(
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s'
+						),
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s'
+						),
+					),
+				);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_search_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['s'])) {
+			$search_string = '%' . sanitize_text_field($request['s']) . '%';
+			$where['OR*search_conditions'] = array(
+				'Event.EVT_name'                          => array('LIKE', $search_string),
+				'Event.EVT_desc'                          => array('LIKE', $search_string),
+				'Event.EVT_short_desc'                    => array('LIKE', $search_string),
+				'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
+				'Attendee.ATT_fname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_lname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
+				'Attendee.ATT_email'                      => array('LIKE', $search_string),
+				'Attendee.ATT_address'                    => array('LIKE', $search_string),
+				'Attendee.ATT_address2'                   => array('LIKE', $search_string),
+				'Attendee.ATT_city'                       => array('LIKE', $search_string),
+				'REG_final_price'                         => array('LIKE', $search_string),
+				'REG_code'                                => array('LIKE', $search_string),
+				'REG_count'                               => array('LIKE', $search_string),
+				'REG_group_size'                          => array('LIKE', $search_string),
+				'Ticket.TKT_name'                         => array('LIKE', $search_string),
+				'Ticket.TKT_description'                  => array('LIKE', $search_string),
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
+			);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param array $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_where_conditions_for_registrations_query($request)
+	{
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			array_merge(
+				$this->addAttendeeIdToWhereConditions($request),
+				$this->_add_event_id_to_where_conditions($request),
+				$this->_add_category_id_to_where_conditions($request),
+				$this->_add_datetime_id_to_where_conditions($request),
+				$this->_add_registration_status_to_where_conditions($request),
+				$this->_add_date_to_where_conditions($request),
+				$this->_add_search_to_where_conditions($request)
+			),
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function _get_orderby_for_registrations_query()
+	{
+		$orderby_field = ! empty($this->_req_data['orderby'])
+			? sanitize_text_field($this->_req_data['orderby'])
+			: '_REG_date';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby = array('REG_ID');
+				break;
+			case '_Reg_status':
+				$orderby = array('STS_ID');
+				break;
+			case 'ATT_fname':
+				$orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
+				break;
+			case 'ATT_lname':
+				$orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
+				break;
+			case 'event_name':
+				$orderby = array('Event.EVT_name');
+				break;
+			case 'DTT_EVT_start':
+				$orderby = array('Event.Datetime.DTT_EVT_start');
+				break;
+			case '_REG_date':
+				$orderby = array('REG_date');
+				break;
+			default:
+				$orderby = array($orderby_field);
+				break;
+		}
+
+		// order
+		$order = ! empty($this->_req_data['order'])
+			? sanitize_text_field($this->_req_data['order'])
+			: 'DESC';
+		$orderby = array_combine(
+			$orderby,
+			array_fill(0, count($orderby), $order)
+		);
+		// because there are many registrations with the same date, define
+		// a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($orderby['REG_ID'])) {
+			$orderby['REG_ID'] = $order;
+		}
+
+		$orderby = apply_filters(
+			'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
+			$orderby,
+			$this->_req_data
+		);
+
+		return array('order_by' => $orderby);
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param $per_page
+	 * @return array
+	 */
+	protected function _get_limit($per_page)
+	{
+		$current_page = ! empty($this->_req_data['paged'])
+			? absint($this->_req_data['paged'])
+			: 1;
+		$per_page = ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+
+		// -1 means return all results so get out if that's set.
+		if ((int) $per_page === -1) {
+			return array();
+		}
+		$per_page = absint($per_page);
+		$offset = ($current_page - 1) * $per_page;
+		return array('limit' => array($offset, $per_page));
+	}
+
+
+	public function get_registration_status_array()
+	{
+		return self::$_reg_status;
+	}
+
+
+
+
+	/***************************************        REGISTRATION DETAILS        ***************************************/
+	/**
+	 *        generates HTML for the View Registration Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _registration_details()
+	{
+		$this->_template_args = array();
+		$this->_set_registration_object();
+		if (is_object($this->_registration)) {
+			$transaction = $this->_registration->transaction()
+				? $this->_registration->transaction()
+				: EE_Transaction::new_instance();
+			$this->_session = $transaction->session_data();
+			$event_id = $this->_registration->event_ID();
+			$this->_template_args['reg_nmbr']['value'] = $this->_registration->ID();
+			$this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso');
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
+			$this->_template_args['grand_total'] = $transaction->total();
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+			// link back to overview
+			$this->_template_args['reg_overview_url'] = REG_ADMIN_URL;
+			$this->_template_args['registration'] = $this->_registration;
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'default',
+					'event_id' => $event_id,
+				),
+				REG_ADMIN_URL
+			);
+			$this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event_id,
+					'page'   => 'espresso_transactions',
+				),
+				admin_url('admin.php')
+			);
+			$this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_events',
+					'action' => 'edit',
+					'post'   => $event_id,
+				),
+				admin_url('admin.php')
+			);
+			// next and previous links
+			$next_reg = $this->_registration->next(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['next_registration'] = $next_reg
+				? $this->_next_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $next_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-right ee-icon-size-22'
+				)
+				: '';
+			$previous_reg = $this->_registration->previous(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['previous_registration'] = $previous_reg
+				? $this->_previous_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $previous_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-left ee-icon-size-22'
+				)
+				: '';
+			// grab header
+			$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+			$this->_template_args['REG_ID'] = $this->_registration->ID();
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+		} else {
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
+		}
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _registration_details_metaboxes()
+	{
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
+		$this->_set_registration_object();
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
+		add_meta_box(
+			'edit-reg-status-mbox',
+			esc_html__('Registration Status', 'event_espresso'),
+			array($this, 'set_reg_status_buttons_metabox'),
+			$this->wp_page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'edit-reg-details-mbox',
+			esc_html__('Registration Details', 'event_espresso'),
+			array($this, '_reg_details_meta_box'),
+			$this->wp_page_slug,
+			'normal',
+			'high'
+		);
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'edit-reg-questions-mbox',
+				$this->_registration->ID()
+			)
+		) {
+			add_meta_box(
+				'edit-reg-questions-mbox',
+				esc_html__('Registration Form Answers', 'event_espresso'),
+				array($this, '_reg_questions_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+		add_meta_box(
+			'edit-reg-registrant-mbox',
+			esc_html__('Contact Details', 'event_espresso'),
+			array($this, '_reg_registrant_side_meta_box'),
+			$this->wp_page_slug,
+			'side',
+			'high'
+		);
+		if ($this->_registration->group_size() > 1) {
+			add_meta_box(
+				'edit-reg-attendees-mbox',
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
+				array($this, '_reg_attendees_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+	}
+
+
+	/**
+	 * set_reg_status_buttons_metabox
+	 *
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function set_reg_status_buttons_metabox()
+	{
+		$this->_set_registration_object();
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
+		echo $change_reg_status_form->form_open(
+			self::add_query_args_and_nonce(
+				array(
+					'action' => 'change_reg_status',
+				),
+				REG_ADMIN_URL
+			)
+		);
+		echo $change_reg_status_form->get_html();
+		echo $change_reg_status_form->form_close();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _generate_reg_status_change_form()
+	{
+		$reg_status_change_form_array = array(
+			'name'            => 'reg_status_change_form',
+			'html_id'         => 'reg-status-change-form',
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+			'subsections'     => array(
+				'return'             => new EE_Hidden_Input(
+					array(
+						'name'    => 'return',
+						'default' => 'view_registration',
+					)
+				),
+				'REG_ID'             => new EE_Hidden_Input(
+					array(
+						'name'    => 'REG_ID',
+						'default' => $this->_registration->ID(),
+					)
+				),
+				'current_status'     => new EE_Form_Section_HTML(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(
+									esc_html__('Current Registration Status', 'event_espresso')
+								)
+							)
+						)
+						. EEH_HTML::td(
+							EEH_HTML::strong(
+								$this->_registration->pretty_status(),
+								'',
+								'status-' . $this->_registration->status_ID(),
+								'line-height: 1em; font-size: 1.5em; font-weight: bold;'
+							)
+						)
+					)
+				)
+			)
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_registration',
+			'toggle_registration_status',
+			$this->_registration->ID()
+		)) {
+			$reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input(
+				$this->_get_reg_statuses(),
+				array(
+					'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
+					'default'         => $this->_registration->status_ID(),
+				)
+			);
+			$reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input(
+				array(
+					'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
+					'default'         => false,
+					'html_help_text'  => esc_html__(
+						'If set to "Yes", then the related messages will be sent to the registrant.',
+						'event_espresso'
+					)
+				)
+			);
+			$reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input(
+				array(
+					'html_class'      => 'button-primary',
+					'html_label_text' => '&nbsp;',
+					'default'         => esc_html__('Update Registration Status', 'event_espresso'),
+				)
+			);
+		}
+		return new EE_Form_Section_Proper($reg_status_change_form_array);
+	}
+
+
+	/**
+	 * Returns an array of all the buttons for the various statuses and switch status actions
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _get_reg_statuses()
+	{
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
+		unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
+		// get current reg status
+		$current_status = $this->_registration->status_ID();
+		// is registration for free event? This will determine whether to display the pending payment option
+		if ($current_status !== EEM_Registration::status_id_pending_payment
+			&& EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
+		) {
+			unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
+		}
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
+	}
+
+
+	/**
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
+	 *
+	 * @param bool $status REG status given for changing registrations to.
+	 * @param bool $notify Whether to send messages notifications or not.
+	 * @return array (array with reg_id(s) updated and whether update was successful.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _set_registration_status_from_request($status = false, $notify = false)
+	{
+		if (isset($this->_req_data['reg_status_change_form'])) {
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
+				? (array) $this->_req_data['reg_status_change_form']['REG_ID']
+				: array();
+		} else {
+			$REG_IDs = isset($this->_req_data['_REG_ID'])
+				? (array) $this->_req_data['_REG_ID']
+				: array();
+		}
+		// sanitize $REG_IDs
+		$REG_IDs = array_map('absint', $REG_IDs);
+		// and remove empty entries
+		$REG_IDs = array_filter($REG_IDs);
+
+		$result = $this->_set_registration_status($REG_IDs, $status, $notify);
+
+		/**
+		 * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
+		 * Currently this value is used downstream by the _process_resend_registration method.
+		 *
+		 * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
+		 * @param bool                     $status           The status registrations were changed to.
+		 * @param bool                     $success          If the status was changed successfully for all registrations.
+		 * @param Registrations_Admin_Page $admin_page_object
+		 */
+		$this->_req_data['_REG_ID'] = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
+			$result['REG_ID'],
+			$status,
+			$result['success'],
+			$this
+		);
+
+		// notify?
+		if ($notify
+			&& $result['success']
+			&& ! empty($this->_req_data['_REG_ID'])
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
+	 *
+	 * @param array  $REG_IDs
+	 * @param string $status
+	 * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
+	 *                        slug sent with setting the registration status.
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false)
+	{
+		$success = false;
+		// typecast $REG_IDs
+		$REG_IDs = (array) $REG_IDs;
+		if (! empty($REG_IDs)) {
+			$success = true;
+			// set default status if none is passed
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
+			$status_context = $notify
+				? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+				: Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
+			// loop through REG_ID's and change status
+			foreach ($REG_IDs as $REG_ID) {
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+				if ($registration instanceof EE_Registration) {
+					$registration->set_status(
+						$status,
+						false,
+						new Context(
+							$status_context,
+							esc_html__(
+								'Manually triggered status change on a Registration Admin Page route.',
+								'event_espresso'
+							)
+						)
+					);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+
+		// return $success and processed registrations
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
+	}
+
+
+	/**
+	 * Common logic for setting up success message and redirecting to appropriate route
+	 *
+	 * @param  string $STS_ID status id for the registration changed to
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _reg_status_change_return($STS_ID, $notify = false)
+	{
+		$result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
+			: array('success' => false);
+		$success = isset($result['success']) && $result['success'];
+		// setup success message
+		if ($success) {
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
+				$msg = sprintf(
+					esc_html__('Registration status has been set to %s', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower')
+				);
+			} else {
+				$msg = sprintf(
+					esc_html__('Registrations have been set to %s.', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower')
+				);
+			}
+			EE_Error::add_success($msg);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong, and the status was not changed',
+					'event_espresso'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+		}
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
+		} else {
+			$route = array('action' => 'default');
+		}
+		$route = $this->mergeExistingRequestParamsWithRedirectArgs($route);
+		$this->_redirect_after_action($success, '', '', $route, true);
+	}
+
+
+	/**
+	 * incoming reg status change from reg details page.
+	 *
+	 * @return void
+	 */
+	protected function _change_reg_status()
+	{
+		$this->_req_data['return'] = 'view_registration';
+		// set notify based on whether the send notifications toggle is set or not
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
+		// $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
+			case EEM_Registration::status_id_approved:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'):
+				$this->approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_pending_payment:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'):
+				$this->pending_registration($notify);
+				break;
+			case EEM_Registration::status_id_not_approved:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'):
+				$this->not_approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_declined:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'):
+				$this->decline_registration($notify);
+				break;
+			case EEM_Registration::status_id_cancelled:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'):
+				$this->cancel_registration($notify);
+				break;
+			case EEM_Registration::status_id_wait_list:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'):
+				$this->wait_list_registration($notify);
+				break;
+			case EEM_Registration::status_id_incomplete:
+			default:
+				$result['success'] = false;
+				unset($this->_req_data['return']);
+				$this->_reg_status_change_return('', false);
+				break;
+		}
+	}
+
+
+	/**
+	 * Callback for bulk action routes.
+	 * Note: although we could just register the singular route callbacks for each bulk action route as well, this
+	 * method was chosen so there is one central place all the registration status bulk actions are going through.
+	 * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
+	 * when an action is happening on just a single registration).
+	 *
+	 * @param      $action
+	 * @param bool $notify
+	 */
+	protected function bulk_action_on_registrations($action, $notify = false)
+	{
+		do_action(
+			'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
+			$this,
+			$action,
+			$notify
+		);
+		$method = $action . '_registration';
+		if (method_exists($this, $method)) {
+			$this->$method($notify);
+		}
+	}
+
+
+	/**
+	 * approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their approval.
+	 * @return void
+	 */
+	protected function approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function decline_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
+	}
+
+
+	/**
+	 *        cancel_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function cancel_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
+	}
+
+
+	/**
+	 *        not_approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function not_approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function pending_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
+	}
+
+
+	/**
+	 * waitlist_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function wait_list_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public function _reg_details_meta_box()
+	{
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		EEH_Autoloader::register_line_item_filter_autoloaders();
+		EE_Registry::instance()->load_helper('Line_Item');
+		$transaction = $this->_registration->transaction() ? $this->_registration->transaction()
+			: EE_Transaction::new_instance();
+		$this->_session = $transaction->session_data();
+		$filters = new EE_Line_Item_Filter_Collection();
+		// $filters->add( new EE_Non_Zero_Line_Item_Filter() );
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
+		$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
+			$filters,
+			$transaction->total_line_item()
+		);
+		$filtered_line_item_tree = $line_item_filter_processor->process();
+		$line_item_display = new EE_Line_Item_Display(
+			'reg_admin_table',
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
+			$filtered_line_item_tree,
+			array('EE_Registration' => $this->_registration)
+		);
+		$attendee = $this->_registration->attendee();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction'
+		)) {
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'view_transaction',
+						'TXN_ID' => $transaction->ID(),
+					),
+					TXN_ADMIN_URL
+				),
+				esc_html__(' View Transaction', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-cart'
+			);
+		} else {
+			$this->_template_args['view_transaction_button'] = '';
+		}
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'      => 'resend_registration',
+						'_REG_ID'     => $this->_registration->ID(),
+						'redirect_to' => 'view_registration',
+					),
+					REG_ADMIN_URL
+				),
+				esc_html__(' Resend Registration', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-email-alt'
+			);
+		} else {
+			$this->_template_args['resend_registration_button'] = '';
+		}
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		$payment = $transaction->get_first_related('Payment');
+		$payment = ! $payment instanceof EE_Payment
+			? EE_Payment::new_instance()
+			: $payment;
+		$payment_method = $payment->get_first_related('Payment_Method');
+		$payment_method = ! $payment_method instanceof EE_Payment_Method
+			? EE_Payment_Method::new_instance()
+			: $payment_method;
+		$reg_details = array(
+			'payment_method'       => $payment_method->name(),
+			'response_msg'         => $payment->gateway_response(),
+			'registration_id'      => $this->_registration->get('REG_code'),
+			'registration_session' => $this->_registration->session_ID(),
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
+		);
+		if (isset($reg_details['registration_id'])) {
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
+				'Registration ID',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
+		}
+		if (isset($reg_details['payment_method'])) {
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
+				'Most Recent Payment Method',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
+			$this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg'];
+			$this->_template_args['reg_details']['response_msg']['label'] = esc_html__(
+				'Payment method response',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
+		}
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address'];
+		$this->_template_args['reg_details']['ip_address']['label'] = esc_html__(
+			'Registration placed from IP',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['ip_address']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent'];
+		$this->_template_args['reg_details']['user_agent']['label'] = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['user_agent']['class'] = 'large-text';
+		$this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'   => 'default',
+				'event_id' => $this->_registration->event_ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$this->_template_args['REG_ID'] = $this->_registration->ID();
+		$this->_template_args['event_id'] = $this->_registration->event_ID();
+		$template_path =
+			REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * generates HTML for the Registration Questions meta box.
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
+	 * otherwise uses new forms system
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_questions_meta_box()
+	{
+		// allow someone to override this method entirely
+		if (apply_filters(
+			'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+			true,
+			$this,
+			$this->_registration
+		)) {
+			$form = $this->_get_reg_custom_questions_form(
+				$this->_registration->ID()
+			);
+			$this->_template_args['att_questions'] = count($form->subforms()) > 0
+				? $form->get_html_and_js()
+				: '';
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
+			$this->_template_args['REG_ID'] = $this->_registration->ID();
+			$template_path =
+				REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
+		}
+	}
+
+
+	/**
+	 * form_before_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_before_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 	<table class="form-table ee-width-100">
 		<tbody>
 			';
-    }
-
-
-    /**
-     * form_after_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_after_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_after_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_after_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr class="hide-if-no-js">
 				<th> </th>
 				<td class="reg-admin-edit-attendee-question-td">
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
-               . esc_attr__('click to edit question', 'event_espresso')
-               . '">
+			   . esc_attr__('click to edit question', 'event_espresso')
+			   . '">
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
-               . esc_html__('edit the above question group', 'event_espresso')
-               . '</span>
+			   . esc_html__('edit the above question group', 'event_espresso')
+			   . '</span>
 						<div class="dashicons dashicons-edit"></div>
 					</a>
 				</td>
@@ -2416,608 +2416,608 @@ 
 		</tbody>
 	</table>
 ';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function form_form_field_label_wrap($label)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function form_form_field_label_wrap($label)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $input
-     * @return        string
-     */
-    public function form_form_field_input__wrap($input)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $input
+	 * @return        string
+	 */
+	public function form_form_field_input__wrap($input)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
-     * to display the page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_attendee_registration_form()
-    {
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
-            if ($success) {
-                $what = esc_html__('Registration Form', 'event_espresso');
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
-                    : array('action' => 'default');
-                $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the form for saving registrations custom questions (if done
-     * previously retrieves the cached form object, which may have validation errors in it)
-     *
-     * @param int $REG_ID
-     * @return EE_Registration_Custom_Questions_Form
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_reg_custom_questions_form($REG_ID)
-    {
-        if (! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
-                EEM_Registration::instance()->get_one_by_ID($REG_ID)
-            );
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
-        }
-        return $this->_reg_custom_questions_form;
-    }
-
-
-    /**
-     * Saves
-     *
-     * @access private
-     * @param bool $REG_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_reg_custom_questions_form($REG_ID = false)
-    {
-        if (! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No registration ID was received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
-        $form->receive_form_submission($this->_req_data);
-        $success = false;
-        if ($form->is_valid()) {
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
-                foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions = array(
-                        'QST_ID' => $question_id,
-                        'REG_ID' => $REG_ID,
-                    );
-                    $possibly_new_values = array(
-                        'ANS_value' => $input->normalized_value(),
-                    );
-                    $answer = EEM_Answer::instance()->get_one(array($where_conditions));
-                    if ($answer instanceof EE_Answer) {
-                        $success = $answer->save($possibly_new_values);
-                    } else {
-                        // insert it then
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
-                        $answer = EE_Answer::new_instance($cols_n_vals);
-                        $success = $answer->save();
-                    }
-                }
-            }
-        } else {
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _reg_attendees_meta_box()
-    {
-        $REG = EEM_Registration::instance();
-        // get all other registrations on this transaction, and cache
-        // the attendees for them so we don't have to run another query using force_join
-        $registrations = $REG->get_all(
-            array(
-                array(
-                    'TXN_ID' => $this->_registration->transaction_ID(),
-                    'REG_ID' => array('!=', $this->_registration->ID()),
-                ),
-                'force_join' => array('Attendee'),
-            )
-        );
-        $this->_template_args['attendees'] = array();
-        $this->_template_args['attendee_notice'] = '';
-        if (empty($registrations)
-            || (is_array($registrations)
-                && ! EEH_Array::get_one_item_from_array($registrations))
-        ) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
-        } else {
-            $att_nmbr = 1;
-            foreach ($registrations as $registration) {
-                /* @var $registration EE_Registration */
-                $attendee = $registration->attendee()
-                    ? $registration->attendee()
-                    : EEM_Attendee::instance()
-                                  ->create_default_object();
-                $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID();
-                $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname();
-                $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname();
-                $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email();
-                $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode(
-                    ', ',
-                    $attendee->full_address_as_array()
-                );
-                $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce(
-                    array(
-                        'action' => 'edit_attendee',
-                        'post'   => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event
-                    ? $registration->event_obj()->name()
-                    : '';
-                $att_nmbr++;
-            }
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Edit Registration side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _reg_registrant_side_meta_box()
-    {
-        /*@var $attendee EE_Attendee */
-        $att_check = $this->_registration->attendee();
-        $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
-        // now let's determine if this is not the primary registration.  If it isn't then we set the
-        // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
-        // primary registration object (that way we know if we need to show create button or not)
-        if (! $this->_registration->is_primary_registrant()) {
-            $primary_registration = $this->_registration->get_primary_registration();
-            $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
-                : null;
-            if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
-                // in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
-                // custom attendee object so let's not worry about the primary reg.
-                $primary_registration = null;
-            }
-        } else {
-            $primary_registration = null;
-        }
-        $this->_template_args['ATT_ID'] = $attendee->ID();
-        $this->_template_args['fname'] = $attendee->fname();
-        $this->_template_args['lname'] = $attendee->lname();
-        $this->_template_args['email'] = $attendee->email();
-        $this->_template_args['phone'] = $attendee->phone();
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
-        // edit link
-        $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
-        // create link
-        $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'duplicate_attendee',
-                    '_REG_ID' => $this->_registration->ID(),
-                ),
-                REG_ADMIN_URL
-            ) : '';
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
-        $this->_template_args['att_check'] = $att_check;
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * trash or restore registrations
-     *
-     * @param  boolean $trash whether to archive or restore
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @access protected
-     */
-    protected function _trash_or_restore_registrations($trash = true)
-    {
-        // if empty _REG_ID then get out because there's nothing to do
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
-                        'event_espresso'
-                    ),
-                    $trash ? 'trash' : 'restore'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-        $success = 0;
-        $overwrite_msgs = false;
-        // Checkboxes
-        if (! is_array($this->_req_data['_REG_ID'])) {
-            $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
-        }
-        $reg_count = count($this->_req_data['_REG_ID']);
-        // cycle thru checkboxes
-        foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
-            /** @var EE_Registration $REG */
-            $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-            $payments = $REG->registration_payments();
-            if (! empty($payments)) {
-                $name = $REG->attendee() instanceof EE_Attendee
-                    ? $REG->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $overwrite_msgs = true;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
-                            'event_espresso'
-                        ),
-                        $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // can't trash this registration because it has payments.
-                continue;
-            }
-            $updated = $trash ? $REG->delete() : $REG->restore();
-            if ($updated) {
-                $success++;
-            }
-        }
-        $this->_redirect_after_action(
-            $success === $reg_count, // were ALL registrations affected?
-            $success > 1
-                ? esc_html__('Registrations', 'event_espresso')
-                : esc_html__('Registration', 'event_espresso'),
-            $trash
-                ? esc_html__('moved to the trash', 'event_espresso')
-                : esc_html__('restored', 'event_espresso'),
-            $this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')),
-            $overwrite_msgs
-        );
-    }
-
-
-    /**
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
-     * registration but also.
-     * 1. Removing relations to EE_Attendee
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
-     * ALSO trashed.
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
-     * 4. Removing relationships between all tickets and the related registrations
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
-     * 6. Deleting permanently any related Checkins.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_registrations()
-    {
-        $REG_MDL = EEM_Registration::instance();
-        $success = 1;
-        // Checkboxes
-        if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if (! $REG instanceof EE_Registration) {
-                    continue;
-                }
-                $deleted = $this->_delete_registration($REG);
-                if (! $deleted) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $REG_ID = $this->_req_data['_REG_ID'];
-            $REG = $REG_MDL->get_one_by_ID($REG_ID);
-            $deleted = $this->_delete_registration($REG);
-            if (! $deleted) {
-                $success = 0;
-            }
-        }
-        $what = $success > 1
-            ? esc_html__('Registrations', 'event_espresso')
-            : esc_html__('Registration', 'event_espresso');
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
-            true
-        );
-    }
-
-
-    /**
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
-     * models get affected.
-     *
-     * @param  EE_Registration $REG registration to be deleted permenantly
-     * @return bool true = successful deletion, false = fail.
-     * @throws EE_Error
-     */
-    protected function _delete_registration(EE_Registration $REG)
-    {
-        // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
-        // registrations on the transaction that are NOT trashed.
-        $TXN = $REG->get_first_related('Transaction');
-        $REGS = $TXN->get_many_related('Registration');
-        $all_trashed = true;
-        foreach ($REGS as $registration) {
-            if (! $registration->get('REG_deleted')) {
-                $all_trashed = false;
-            }
-        }
-        if (! $all_trashed) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // k made it here so that means we can delete all the related transactions and their answers (but let's do them
-        // separately from THIS one).
-        foreach ($REGS as $registration) {
-            // delete related answers
-            $registration->delete_related_permanently('Answer');
-            // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
-            $attendee = $registration->get_first_related('Attendee');
-            if ($attendee instanceof EE_Attendee) {
-                $registration->_remove_relation_to($attendee, 'Attendee');
-            }
-            // now remove relationships to tickets on this registration.
-            $registration->_remove_relations('Ticket');
-            // now delete permanently the checkins related to this registration.
-            $registration->delete_related_permanently('Checkin');
-            if ($registration->ID() === $REG->ID()) {
-                continue;
-            } //we don't want to delete permanently the existing registration just yet.
-            // remove relation to transaction for these registrations if NOT the existing registrations
-            $registration->_remove_relations('Transaction');
-            // delete permanently any related messages.
-            $registration->delete_related_permanently('Message');
-            // now delete this registration permanently
-            $registration->delete_permanently();
-        }
-        // now all related registrations on the transaction are handled.  So let's just handle this registration itself
-        // (the transaction and line items should be all that's left).
-        // delete the line items related to the transaction for this registration.
-        $TXN->delete_related_permanently('Line_Item');
-        // we need to remove all the relationships on the transaction
-        $TXN->delete_related_permanently('Payment');
-        $TXN->delete_related_permanently('Extra_Meta');
-        $TXN->delete_related_permanently('Message');
-        // now we can delete this REG permanently (and the transaction of course)
-        $REG->delete_related_permanently('Transaction');
-        return $REG->delete_permanently();
-    }
-
-
-    /**
-     *    generates HTML for the Register New Attendee Admin page
-     *
-     * @access private
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function new_registration()
-    {
-        if (! $this->_set_reg_event()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Unable to continue with registering because there is no Event ID in the request',
-                    'event_espresso'
-                )
-            );
-        }
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // gotta start with a clean slate if we're not coming here via ajax
-        if (! defined('DOING_AJAX')
-            && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
-        ) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        $this->_template_args['event_name'] = '';
-        // event name
-        if ($this->_reg_event) {
-            $this->_template_args['event_name'] = $this->_reg_event->name();
-            $edit_event_url = self::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit',
-                    'post'   => $this->_reg_event->ID(),
-                ),
-                EVENTS_ADMIN_URL
-            );
-            $edit_event_lnk = '<a href="'
-                              . $edit_event_url
-                              . '" title="'
-                              . esc_attr__('Edit ', 'event_espresso')
-                              . $this->_reg_event->name()
-                              . '">'
-                              . esc_html__('Edit Event', 'event_espresso')
-                              . '</a>';
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
-                                                   . $edit_event_lnk
-                                                   . '</span>';
-        }
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
-        if (defined('DOING_AJAX')) {
-            $this->_return_json();
-        }
-        // grab header
-        $template_path =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This returns the content for a registration step
-     *
-     * @access protected
-     * @return string html
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_registration_step_content()
-    {
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
-            $warning_msg = sprintf(
-                esc_html__(
-                    '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<h3 class="important-notice">',
-                '</h3>',
-                '<div class="float-right">',
-                '<span id="redirect_timer" class="important-notice">30</span>',
-                '</div>',
-                '<b>',
-                '</b>'
-            );
-            return '
+	}
+
+
+	/**
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
+	 * to display the page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_attendee_registration_form()
+	{
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			$REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
+			if ($success) {
+				$what = esc_html__('Registration Form', 'event_espresso');
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
+					: array('action' => 'default');
+				$this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the form for saving registrations custom questions (if done
+	 * previously retrieves the cached form object, which may have validation errors in it)
+	 *
+	 * @param int $REG_ID
+	 * @return EE_Registration_Custom_Questions_Form
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_reg_custom_questions_form($REG_ID)
+	{
+		if (! $this->_reg_custom_questions_form) {
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
+				EEM_Registration::instance()->get_one_by_ID($REG_ID)
+			);
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
+		}
+		return $this->_reg_custom_questions_form;
+	}
+
+
+	/**
+	 * Saves
+	 *
+	 * @access private
+	 * @param bool $REG_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_reg_custom_questions_form($REG_ID = false)
+	{
+		if (! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No registration ID was received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
+		$form->receive_form_submission($this->_req_data);
+		$success = false;
+		if ($form->is_valid()) {
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
+				foreach ($question_group_form->inputs() as $question_id => $input) {
+					$where_conditions = array(
+						'QST_ID' => $question_id,
+						'REG_ID' => $REG_ID,
+					);
+					$possibly_new_values = array(
+						'ANS_value' => $input->normalized_value(),
+					);
+					$answer = EEM_Answer::instance()->get_one(array($where_conditions));
+					if ($answer instanceof EE_Answer) {
+						$success = $answer->save($possibly_new_values);
+					} else {
+						// insert it then
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
+						$answer = EE_Answer::new_instance($cols_n_vals);
+						$success = $answer->save();
+					}
+				}
+			}
+		} else {
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _reg_attendees_meta_box()
+	{
+		$REG = EEM_Registration::instance();
+		// get all other registrations on this transaction, and cache
+		// the attendees for them so we don't have to run another query using force_join
+		$registrations = $REG->get_all(
+			array(
+				array(
+					'TXN_ID' => $this->_registration->transaction_ID(),
+					'REG_ID' => array('!=', $this->_registration->ID()),
+				),
+				'force_join' => array('Attendee'),
+			)
+		);
+		$this->_template_args['attendees'] = array();
+		$this->_template_args['attendee_notice'] = '';
+		if (empty($registrations)
+			|| (is_array($registrations)
+				&& ! EEH_Array::get_one_item_from_array($registrations))
+		) {
+			EE_Error::add_error(
+				esc_html__(
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
+		} else {
+			$att_nmbr = 1;
+			foreach ($registrations as $registration) {
+				/* @var $registration EE_Registration */
+				$attendee = $registration->attendee()
+					? $registration->attendee()
+					: EEM_Attendee::instance()
+								  ->create_default_object();
+				$this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID();
+				$this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname();
+				$this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname();
+				$this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email();
+				$this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
+				$this->_template_args['attendees'][ $att_nmbr ]['address'] = implode(
+					', ',
+					$attendee->full_address_as_array()
+				);
+				$this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce(
+					array(
+						'action' => 'edit_attendee',
+						'post'   => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event
+					? $registration->event_obj()->name()
+					: '';
+				$att_nmbr++;
+			}
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		}
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Edit Registration side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _reg_registrant_side_meta_box()
+	{
+		/*@var $attendee EE_Attendee */
+		$att_check = $this->_registration->attendee();
+		$attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
+		// now let's determine if this is not the primary registration.  If it isn't then we set the
+		// primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
+		// primary registration object (that way we know if we need to show create button or not)
+		if (! $this->_registration->is_primary_registrant()) {
+			$primary_registration = $this->_registration->get_primary_registration();
+			$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
+				: null;
+			if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+				// in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
+				// custom attendee object so let's not worry about the primary reg.
+				$primary_registration = null;
+			}
+		} else {
+			$primary_registration = null;
+		}
+		$this->_template_args['ATT_ID'] = $attendee->ID();
+		$this->_template_args['fname'] = $attendee->fname();
+		$this->_template_args['lname'] = $attendee->lname();
+		$this->_template_args['email'] = $attendee->email();
+		$this->_template_args['phone'] = $attendee->phone();
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
+		// edit link
+		$this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
+		// create link
+		$this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'duplicate_attendee',
+					'_REG_ID' => $this->_registration->ID(),
+				),
+				REG_ADMIN_URL
+			) : '';
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
+		$this->_template_args['att_check'] = $att_check;
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * trash or restore registrations
+	 *
+	 * @param  boolean $trash whether to archive or restore
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_registrations($trash = true)
+	{
+		// if empty _REG_ID then get out because there's nothing to do
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
+						'event_espresso'
+					),
+					$trash ? 'trash' : 'restore'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+		$success = 0;
+		$overwrite_msgs = false;
+		// Checkboxes
+		if (! is_array($this->_req_data['_REG_ID'])) {
+			$this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
+		}
+		$reg_count = count($this->_req_data['_REG_ID']);
+		// cycle thru checkboxes
+		foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
+			/** @var EE_Registration $REG */
+			$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+			$payments = $REG->registration_payments();
+			if (! empty($payments)) {
+				$name = $REG->attendee() instanceof EE_Attendee
+					? $REG->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$overwrite_msgs = true;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
+							'event_espresso'
+						),
+						$name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// can't trash this registration because it has payments.
+				continue;
+			}
+			$updated = $trash ? $REG->delete() : $REG->restore();
+			if ($updated) {
+				$success++;
+			}
+		}
+		$this->_redirect_after_action(
+			$success === $reg_count, // were ALL registrations affected?
+			$success > 1
+				? esc_html__('Registrations', 'event_espresso')
+				: esc_html__('Registration', 'event_espresso'),
+			$trash
+				? esc_html__('moved to the trash', 'event_espresso')
+				: esc_html__('restored', 'event_espresso'),
+			$this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')),
+			$overwrite_msgs
+		);
+	}
+
+
+	/**
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
+	 * registration but also.
+	 * 1. Removing relations to EE_Attendee
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
+	 * ALSO trashed.
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
+	 * 4. Removing relationships between all tickets and the related registrations
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
+	 * 6. Deleting permanently any related Checkins.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_registrations()
+	{
+		$REG_MDL = EEM_Registration::instance();
+		$success = 1;
+		// Checkboxes
+		if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
+				if (! $REG instanceof EE_Registration) {
+					continue;
+				}
+				$deleted = $this->_delete_registration($REG);
+				if (! $deleted) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$REG_ID = $this->_req_data['_REG_ID'];
+			$REG = $REG_MDL->get_one_by_ID($REG_ID);
+			$deleted = $this->_delete_registration($REG);
+			if (! $deleted) {
+				$success = 0;
+			}
+		}
+		$what = $success > 1
+			? esc_html__('Registrations', 'event_espresso')
+			: esc_html__('Registration', 'event_espresso');
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			$this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
+			true
+		);
+	}
+
+
+	/**
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
+	 * models get affected.
+	 *
+	 * @param  EE_Registration $REG registration to be deleted permenantly
+	 * @return bool true = successful deletion, false = fail.
+	 * @throws EE_Error
+	 */
+	protected function _delete_registration(EE_Registration $REG)
+	{
+		// first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
+		// registrations on the transaction that are NOT trashed.
+		$TXN = $REG->get_first_related('Transaction');
+		$REGS = $TXN->get_many_related('Registration');
+		$all_trashed = true;
+		foreach ($REGS as $registration) {
+			if (! $registration->get('REG_deleted')) {
+				$all_trashed = false;
+			}
+		}
+		if (! $all_trashed) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// k made it here so that means we can delete all the related transactions and their answers (but let's do them
+		// separately from THIS one).
+		foreach ($REGS as $registration) {
+			// delete related answers
+			$registration->delete_related_permanently('Answer');
+			// remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
+			$attendee = $registration->get_first_related('Attendee');
+			if ($attendee instanceof EE_Attendee) {
+				$registration->_remove_relation_to($attendee, 'Attendee');
+			}
+			// now remove relationships to tickets on this registration.
+			$registration->_remove_relations('Ticket');
+			// now delete permanently the checkins related to this registration.
+			$registration->delete_related_permanently('Checkin');
+			if ($registration->ID() === $REG->ID()) {
+				continue;
+			} //we don't want to delete permanently the existing registration just yet.
+			// remove relation to transaction for these registrations if NOT the existing registrations
+			$registration->_remove_relations('Transaction');
+			// delete permanently any related messages.
+			$registration->delete_related_permanently('Message');
+			// now delete this registration permanently
+			$registration->delete_permanently();
+		}
+		// now all related registrations on the transaction are handled.  So let's just handle this registration itself
+		// (the transaction and line items should be all that's left).
+		// delete the line items related to the transaction for this registration.
+		$TXN->delete_related_permanently('Line_Item');
+		// we need to remove all the relationships on the transaction
+		$TXN->delete_related_permanently('Payment');
+		$TXN->delete_related_permanently('Extra_Meta');
+		$TXN->delete_related_permanently('Message');
+		// now we can delete this REG permanently (and the transaction of course)
+		$REG->delete_related_permanently('Transaction');
+		return $REG->delete_permanently();
+	}
+
+
+	/**
+	 *    generates HTML for the Register New Attendee Admin page
+	 *
+	 * @access private
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function new_registration()
+	{
+		if (! $this->_set_reg_event()) {
+			throw new EE_Error(
+				esc_html__(
+					'Unable to continue with registering because there is no Event ID in the request',
+					'event_espresso'
+				)
+			);
+		}
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// gotta start with a clean slate if we're not coming here via ajax
+		if (! defined('DOING_AJAX')
+			&& (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
+		) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		$this->_template_args['event_name'] = '';
+		// event name
+		if ($this->_reg_event) {
+			$this->_template_args['event_name'] = $this->_reg_event->name();
+			$edit_event_url = self::add_query_args_and_nonce(
+				array(
+					'action' => 'edit',
+					'post'   => $this->_reg_event->ID(),
+				),
+				EVENTS_ADMIN_URL
+			);
+			$edit_event_lnk = '<a href="'
+							  . $edit_event_url
+							  . '" title="'
+							  . esc_attr__('Edit ', 'event_espresso')
+							  . $this->_reg_event->name()
+							  . '">'
+							  . esc_html__('Edit Event', 'event_espresso')
+							  . '</a>';
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
+												   . $edit_event_lnk
+												   . '</span>';
+		}
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
+		if (defined('DOING_AJAX')) {
+			$this->_return_json();
+		}
+		// grab header
+		$template_path =
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This returns the content for a registration step
+	 *
+	 * @access protected
+	 * @return string html
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_registration_step_content()
+	{
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
+			$warning_msg = sprintf(
+				esc_html__(
+					'%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
+					'event_espresso'
+				),
+				'<br />',
+				'<h3 class="important-notice">',
+				'</h3>',
+				'<div class="float-right">',
+				'<span id="redirect_timer" class="important-notice">30</span>',
+				'</div>',
+				'<b>',
+				'</b>'
+			);
+			return '
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -3030,855 +3030,855 @@ 
 	        }
 	    }, 800 );
 	</script >';
-        }
-        $template_args = array(
-            'title'                    => '',
-            'content'                  => '',
-            'step_button_text'         => '',
-            'show_notification_toggle' => false,
-        );
-        // to indicate we're processing a new registration
-        $hidden_fields = array(
-            'processing_registration' => array(
-                'type'  => 'hidden',
-                'value' => 0,
-            ),
-            'event_id'                => array(
-                'type'  => 'hidden',
-                'value' => $this->_reg_event->ID(),
-            ),
-        );
-        // if the cart is empty then we know we're at step one so we'll display ticket selector
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        switch ($step) {
-            case 'ticket':
-                $hidden_fields['processing_registration']['value'] = 1;
-                $template_args['title'] = esc_html__(
-                    'Step One: Select the Ticket for this registration',
-                    'event_espresso'
-                );
-                $template_args['content'] =
-                    EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
-                $template_args['step_button_text'] = esc_html__(
-                    'Add Tickets and Continue to Registrant Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = false;
-                break;
-            case 'questions':
-                $hidden_fields['processing_registration']['value'] = 2;
-                $template_args['title'] = esc_html__(
-                    'Step Two: Add Registrant Details for this Registration',
-                    'event_espresso'
-                );
-                // in theory we should be able to run EED_SPCO at this point because the cart should have been setup
-                // properly by the first process_reg_step run.
-                $template_args['content'] =
-                    EED_Single_Page_Checkout::registration_checkout_for_admin();
-                $template_args['step_button_text'] = esc_html__(
-                    'Save Registration and Continue to Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = true;
-                break;
-        }
-        // we come back to the process_registration_step route.
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
-        return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     *        set_reg_event
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_reg_event()
-    {
-        if (is_object($this->_reg_event)) {
-            return true;
-        }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
-        if (! $EVT_ID) {
-            return false;
-        }
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        return true;
-    }
-
-
-    /**
-     * process_reg_step
-     *
-     * @access        public
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function process_reg_step()
-    {
-        EE_System::do_not_cache();
-        $this->_set_reg_event();
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        EE_Registry::instance()->REQ->set('uts', time());
-        // what step are we on?
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        // if doing ajax then we need to verify the nonce
-        if (defined('DOING_AJAX')) {
-            $nonce = isset($this->_req_data[ $this->_req_nonce ])
-                ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        switch ($step) {
-            case 'ticket':
-                // process ticket selection
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
-                if ($success) {
-                    EE_Error::add_success(
-                        esc_html__(
-                            'Tickets Selected. Now complete the registration.',
-                            'event_espresso'
-                        )
-                    );
-                } else {
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
-                }
-                if (defined('DOING_AJAX')) {
-                    $this->new_registration(); // display next step
-                } else {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 1,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                }
-                break;
-            case 'questions':
-                if (! isset(
-                    $this->_req_data['txn_reg_status_change'],
-                    $this->_req_data['txn_reg_status_change']['send_notifications']
-                )
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
-                }
-                // process registration
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
-                if ($cart instanceof EE_Cart) {
-                    $grand_total = $cart->get_cart_grand_total();
-                    if ($grand_total instanceof EE_Line_Item) {
-                        $grand_total->save_this_and_descendants_to_txn();
-                    }
-                }
-                if (! $transaction instanceof EE_Transaction) {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 2,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    if (defined('DOING_AJAX')) {
-                        // display registration form again because there are errors (maybe validation?)
-                        $this->new_registration();
-                        return;
-                    } else {
-                        $this->_redirect_after_action(
-                            false,
-                            '',
-                            '',
-                            $query_args,
-                            true
-                        );
-                        return;
-                    }
-                }
-                // maybe update status, and make sure to save transaction if not done already
-                if (! $transaction->update_status_based_on_total_paid()) {
-                    $transaction->save();
-                }
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                $this->_req_data = array();
-                $query_args = array(
-                    'action'        => 'redirect_to_txn',
-                    'TXN_ID'        => $transaction->ID(),
-                    'EVT_ID'        => $this->_reg_event->ID(),
-                    'event_name'    => urlencode($this->_reg_event->name()),
-                    'redirect_from' => 'new_registration',
-                );
-                $this->_redirect_after_action(false, '', '', $query_args, true);
-                break;
-        }
-        // what are you looking here for?  Should be nothing to do at this point.
-    }
-
-
-    /**
-     * redirect_to_txn
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function redirect_to_txn()
-    {
-        EE_System::do_not_cache();
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $query_args = array(
-            'action' => 'view_transaction',
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
-            'page'   => 'espresso_transactions',
-        );
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
-            $query_args['EVT_ID'] = $this->_req_data['EVT_ID'];
-            $query_args['event_name'] = urlencode($this->_req_data['event_name']);
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
-        }
-        EE_Error::add_success(
-            esc_html__(
-                'Registration Created.  Please review the transaction and add any payments as necessary',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Attendee Contact List
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _attendee_contact_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *        get_attendees
-     *
-     * @param      $per_page
-     * @param bool $count whether to return count or data.
-     * @param bool $trash
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @access public
-     */
-    public function get_attendees($per_page, $count = false, $trash = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
-        $ATT_MDL = EEM_Attendee::instance();
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-        switch ($this->_req_data['orderby']) {
-            case 'ATT_ID':
-                $orderby = 'ATT_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'ATT_fname';
-                break;
-            case 'ATT_email':
-                $orderby = 'ATT_email';
-                break;
-            case 'ATT_city':
-                $orderby = 'ATT_city';
-                break;
-            case 'STA_ID':
-                $orderby = 'STA_ID';
-                break;
-            case 'CNT_ID':
-                $orderby = 'CNT_ID';
-                break;
-            case 'Registration_Count':
-                $orderby = 'Registration_Count';
-                break;
-            default:
-                $orderby = 'ATT_lname';
-        }
-        $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where = array();
-        if (! empty($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
-                'ATT_fname'                         => array('LIKE', $sstr),
-                'ATT_lname'                         => array('LIKE', $sstr),
-                'ATT_short_bio'                     => array('LIKE', $sstr),
-                'ATT_email'                         => array('LIKE', $sstr),
-                'ATT_address'                       => array('LIKE', $sstr),
-                'ATT_address2'                      => array('LIKE', $sstr),
-                'ATT_city'                          => array('LIKE', $sstr),
-                'Country.CNT_name'                  => array('LIKE', $sstr),
-                'State.STA_name'                    => array('LIKE', $sstr),
-                'ATT_phone'                         => array('LIKE', $sstr),
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
-                'Registration.REG_code'             => array('LIKE', $sstr),
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
-            );
-        }
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : array($offset, $per_page);
-        $query_args = array(
-            $_where,
-            'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
-            'limit'         => $limit,
-        );
-        if (! $count) {
-            $query_args['order_by'] = array($orderby => $sort);
-        }
-        if ($trash) {
-            $query_args[0]['status'] = array('!=', 'publish');
-            $all_attendees = $count
-                ? $ATT_MDL->count($query_args, 'ATT_ID', true)
-                : $ATT_MDL->get_all($query_args);
-        } else {
-            $query_args[0]['status'] = array('IN', array('publish'));
-            $all_attendees = $count
-                ? $ATT_MDL->count($query_args, 'ATT_ID', true)
-                : $ATT_MDL->get_all($query_args);
-        }
-        return $all_attendees;
-    }
-
-
-    /**
-     * This is just taking care of resending the registration confirmation
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _resend_registration()
-    {
-        $this->_process_resend_registration();
-        $query_args = isset($this->_req_data['redirect_to'])
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
-            : array('action' => 'default');
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-    /**
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
-     * to use when selecting registrations
-     *
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
-     *                                                     the query parameters from the request
-     * @return void ends the request with a redirect or download
-     */
-    public function _registrations_report_base($method_name_for_getting_query_params)
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page'        => 'espresso_batch',
-                        'batch'       => 'file',
-                        'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-                        'filters'     => urlencode(
-                            serialize(
-                                call_user_func(
-                                    array($this, $method_name_for_getting_query_params),
-                                    EEH_Array::is_set(
-                                        $this->_req_data,
-                                        'filters',
-                                        array()
-                                    )
-                                )
-                            )
-                        ),
-                        'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
-                        'return_url'  => urlencode($this->_req_data['return_url']),
-                    )
-                )
-            );
-        } else {
-            $new_request_args = array(
-                'export' => 'report',
-                'action' => 'registrations_report_for_event',
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-            );
-            $this->_req_data = array_merge($this->_req_data, $new_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->export();
-            }
-        }
-    }
-
-
-    /**
-     * Creates a registration report using only query parameters in the request
-     *
-     * @return void
-     */
-    public function _registrations_report()
-    {
-        $this->_registrations_report_base('_get_registration_query_parameters');
-    }
-
-
-    public function _contact_list_export()
-    {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export_attendees();
-        }
-    }
-
-
-    public function _contact_list_report()
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page'        => 'espresso_batch',
-                        'batch'       => 'file',
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
-                        'return_url'  => urlencode($this->_req_data['return_url']),
-                    )
-                )
-            );
-        } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->report_attendees();
-            }
-        }
-    }
-
-
-
-
-
-    /***************************************        ATTENDEE DETAILS        ***************************************/
-    /**
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _duplicate_attendee()
-    {
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
-        // verify we have necessary info
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-            $query_args = array('action' => $action);
-            $this->_redirect_after_action('', '', '', $query_args, true);
-        }
-        // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
-        $attendee = $registration->attendee();
-        // remove relation of existing attendee on registration
-        $registration->_remove_relation_to($attendee, 'Attendee');
-        // new attendee
-        $new_attendee = clone $attendee;
-        $new_attendee->set('ATT_ID', 0);
-        $new_attendee->save();
-        // add new attendee to reg
-        $registration->_add_relation_to($new_attendee, 'Attendee');
-        EE_Error::add_success(
-            esc_html__(
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
-                'event_espresso'
-            )
-        );
-        // redirect to edit page for attendee
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
-        $this->_redirect_after_action('', '', '', $query_args, true);
-    }
-
-
-    /**
-     * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
-     *
-     * @param int     $post_id
-     * @param WP_POST $post
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        $success = true;
-        $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
-            ? EEM_Attendee::instance()->get_one_by_ID($post_id)
-            : null;
-        // for attendee updates
-        if ($attendee instanceof EE_Attendee) {
-            // note we should only be UPDATING attendees at this point.
-            $updated_fields = array(
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
-            );
-            foreach ($updated_fields as $field => $value) {
-                $attendee->set($field, $value);
-            }
-
-            // process contact details metabox form handler (which will also save the attendee)
-            $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
-            $success = $contact_details_form->process($this->_req_data);
-
-            $attendee_update_callbacks = apply_filters(
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
-                array()
-            );
-            foreach ($attendee_update_callbacks as $a_callback) {
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
-                                'event_espresso'
-                            ),
-                            $a_callback
-                        )
-                    );
-                }
-            }
-        }
-
-        if ($success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with updating the meta table data for the registration.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-    }
-
-
-    public function attendee_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-        remove_meta_box(
-            'postexcerpt',
-            esc_html__('Excerpt', 'event_espresso'),
-            'post_excerpt_meta_box',
-            $this->_cpt_routes[ $this->_req_action ],
-            'normal',
-            'core'
-        );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core');
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
-            add_meta_box(
-                'postexcerpt',
-                esc_html__('Short Biography', 'event_espresso'),
-                'post_excerpt_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
-                'normal'
-            );
-        }
-        if (post_type_supports('espresso_attendees', 'comments')) {
-            add_meta_box(
-                'commentsdiv',
-                esc_html__('Notes on the Contact', 'event_espresso'),
-                'post_comment_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
-                'normal',
-                'core'
-            );
-        }
-        add_meta_box(
-            'attendee_contact_info',
-            esc_html__('Contact Info', 'event_espresso'),
-            array($this, 'attendee_contact_info'),
-            $this->_cpt_routes[ $this->_req_action ],
-            'side',
-            'core'
-        );
-        add_meta_box(
-            'attendee_details_address',
-            esc_html__('Address Details', 'event_espresso'),
-            array($this, 'attendee_address_details'),
-            $this->_cpt_routes[ $this->_req_action ],
-            'normal',
-            'core'
-        );
-        add_meta_box(
-            'attendee_registrations',
-            esc_html__('Registrations for this Contact', 'event_espresso'),
-            array($this, 'attendee_registrations_meta_box'),
-            $this->_cpt_routes[ $this->_req_action ],
-            'normal',
-            'high'
-        );
-    }
-
-
-    /**
-     * Metabox for attendee contact info
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee contact info ( and form )
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws DomainException
-     */
-    public function attendee_contact_info($post)
-    {
-        // get attendee object ( should already have it )
-        $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
-        $form->enqueueStylesAndScripts();
-        echo $form->display();
-    }
-
-
-    /**
-     * Return form handler for the contact details metabox
-     *
-     * @param EE_Attendee $attendee
-     * @return AttendeeContactDetailsMetaboxFormHandler
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
-    {
-        return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
-    }
-
-
-    /**
-     * Metabox for attendee details
-     *
-     * @param  WP_Post $post wp post object
-     * @throws DomainException
-     */
-    public function attendee_address_details($post)
-    {
-        // get attendee object (should already have it)
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
-        $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
-                        'QST_system'       => 'admin-state',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'STA_ID',
-                    'input_name'     => 'STA_ID',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
-                        'QST_system'       => 'admin-country',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'CNT_ISO',
-                    'input_name'     => 'CNT_ISO',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $template =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     *        _attendee_details
-     *
-     * @access protected
-     * @param $post
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function attendee_registrations_meta_box($post)
-    {
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * add in the form fields for the attendee edit
-     *
-     * @param  WP_Post $post wp post object
-     * @return string html for new form.
-     * @throws DomainException
-     */
-    public function after_title_form_fields($post)
-    {
-        if ($post->post_type == 'espresso_attendees') {
-            $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
-            $template_args['attendee'] = $this->_cpt_model_obj;
-            EEH_Template::display_template($template, $template_args);
-        }
-    }
-
-
-    /**
-     *        _trash_or_restore_attendee
-     *
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @access protected
-     */
-    protected function _trash_or_restore_attendees($trash = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ATT_MDL = EEM_Attendee::instance();
-        $success = 1;
-        // Checkboxes
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
-                if (! $updated) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
-            // get attendee
-            $att = $ATT_MDL->get_one_by_ID($ATT_ID);
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
-            $updated = $att->save();
-            if (! $updated) {
-                $success = 0;
-            }
-        }
-        $what = $success > 1
-            ? esc_html__('Contacts', 'event_espresso')
-            : esc_html__('Contact', 'event_espresso');
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
-    }
+		}
+		$template_args = array(
+			'title'                    => '',
+			'content'                  => '',
+			'step_button_text'         => '',
+			'show_notification_toggle' => false,
+		);
+		// to indicate we're processing a new registration
+		$hidden_fields = array(
+			'processing_registration' => array(
+				'type'  => 'hidden',
+				'value' => 0,
+			),
+			'event_id'                => array(
+				'type'  => 'hidden',
+				'value' => $this->_reg_event->ID(),
+			),
+		);
+		// if the cart is empty then we know we're at step one so we'll display ticket selector
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		switch ($step) {
+			case 'ticket':
+				$hidden_fields['processing_registration']['value'] = 1;
+				$template_args['title'] = esc_html__(
+					'Step One: Select the Ticket for this registration',
+					'event_espresso'
+				);
+				$template_args['content'] =
+					EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
+				$template_args['step_button_text'] = esc_html__(
+					'Add Tickets and Continue to Registrant Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = false;
+				break;
+			case 'questions':
+				$hidden_fields['processing_registration']['value'] = 2;
+				$template_args['title'] = esc_html__(
+					'Step Two: Add Registrant Details for this Registration',
+					'event_espresso'
+				);
+				// in theory we should be able to run EED_SPCO at this point because the cart should have been setup
+				// properly by the first process_reg_step run.
+				$template_args['content'] =
+					EED_Single_Page_Checkout::registration_checkout_for_admin();
+				$template_args['step_button_text'] = esc_html__(
+					'Save Registration and Continue to Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = true;
+				break;
+		}
+		// we come back to the process_registration_step route.
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
+		return EEH_Template::display_template(
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 *        set_reg_event
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_reg_event()
+	{
+		if (is_object($this->_reg_event)) {
+			return true;
+		}
+		$EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+		if (! $EVT_ID) {
+			return false;
+		}
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		return true;
+	}
+
+
+	/**
+	 * process_reg_step
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function process_reg_step()
+	{
+		EE_System::do_not_cache();
+		$this->_set_reg_event();
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		EE_Registry::instance()->REQ->set('uts', time());
+		// what step are we on?
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		// if doing ajax then we need to verify the nonce
+		if (defined('DOING_AJAX')) {
+			$nonce = isset($this->_req_data[ $this->_req_nonce ])
+				? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		switch ($step) {
+			case 'ticket':
+				// process ticket selection
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
+				if ($success) {
+					EE_Error::add_success(
+						esc_html__(
+							'Tickets Selected. Now complete the registration.',
+							'event_espresso'
+						)
+					);
+				} else {
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
+				}
+				if (defined('DOING_AJAX')) {
+					$this->new_registration(); // display next step
+				} else {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 1,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+				}
+				break;
+			case 'questions':
+				if (! isset(
+					$this->_req_data['txn_reg_status_change'],
+					$this->_req_data['txn_reg_status_change']['send_notifications']
+				)
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
+				}
+				// process registration
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
+				if ($cart instanceof EE_Cart) {
+					$grand_total = $cart->get_cart_grand_total();
+					if ($grand_total instanceof EE_Line_Item) {
+						$grand_total->save_this_and_descendants_to_txn();
+					}
+				}
+				if (! $transaction instanceof EE_Transaction) {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 2,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					if (defined('DOING_AJAX')) {
+						// display registration form again because there are errors (maybe validation?)
+						$this->new_registration();
+						return;
+					} else {
+						$this->_redirect_after_action(
+							false,
+							'',
+							'',
+							$query_args,
+							true
+						);
+						return;
+					}
+				}
+				// maybe update status, and make sure to save transaction if not done already
+				if (! $transaction->update_status_based_on_total_paid()) {
+					$transaction->save();
+				}
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+				$this->_req_data = array();
+				$query_args = array(
+					'action'        => 'redirect_to_txn',
+					'TXN_ID'        => $transaction->ID(),
+					'EVT_ID'        => $this->_reg_event->ID(),
+					'event_name'    => urlencode($this->_reg_event->name()),
+					'redirect_from' => 'new_registration',
+				);
+				$this->_redirect_after_action(false, '', '', $query_args, true);
+				break;
+		}
+		// what are you looking here for?  Should be nothing to do at this point.
+	}
+
+
+	/**
+	 * redirect_to_txn
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function redirect_to_txn()
+	{
+		EE_System::do_not_cache();
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$query_args = array(
+			'action' => 'view_transaction',
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
+			'page'   => 'espresso_transactions',
+		);
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
+			$query_args['EVT_ID'] = $this->_req_data['EVT_ID'];
+			$query_args['event_name'] = urlencode($this->_req_data['event_name']);
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
+		}
+		EE_Error::add_success(
+			esc_html__(
+				'Registration Created.  Please review the transaction and add any payments as necessary',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Attendee Contact List
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _attendee_contact_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *        get_attendees
+	 *
+	 * @param      $per_page
+	 * @param bool $count whether to return count or data.
+	 * @param bool $trash
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @access public
+	 */
+	public function get_attendees($per_page, $count = false, $trash = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+		$ATT_MDL = EEM_Attendee::instance();
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+		switch ($this->_req_data['orderby']) {
+			case 'ATT_ID':
+				$orderby = 'ATT_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'ATT_fname';
+				break;
+			case 'ATT_email':
+				$orderby = 'ATT_email';
+				break;
+			case 'ATT_city':
+				$orderby = 'ATT_city';
+				break;
+			case 'STA_ID':
+				$orderby = 'STA_ID';
+				break;
+			case 'CNT_ID':
+				$orderby = 'CNT_ID';
+				break;
+			case 'Registration_Count':
+				$orderby = 'Registration_Count';
+				break;
+			default:
+				$orderby = 'ATT_lname';
+		}
+		$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where = array();
+		if (! empty($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
+				'ATT_fname'                         => array('LIKE', $sstr),
+				'ATT_lname'                         => array('LIKE', $sstr),
+				'ATT_short_bio'                     => array('LIKE', $sstr),
+				'ATT_email'                         => array('LIKE', $sstr),
+				'ATT_address'                       => array('LIKE', $sstr),
+				'ATT_address2'                      => array('LIKE', $sstr),
+				'ATT_city'                          => array('LIKE', $sstr),
+				'Country.CNT_name'                  => array('LIKE', $sstr),
+				'State.STA_name'                    => array('LIKE', $sstr),
+				'ATT_phone'                         => array('LIKE', $sstr),
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
+				'Registration.REG_code'             => array('LIKE', $sstr),
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
+			);
+		}
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $count ? null : array($offset, $per_page);
+		$query_args = array(
+			$_where,
+			'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
+			'limit'         => $limit,
+		);
+		if (! $count) {
+			$query_args['order_by'] = array($orderby => $sort);
+		}
+		if ($trash) {
+			$query_args[0]['status'] = array('!=', 'publish');
+			$all_attendees = $count
+				? $ATT_MDL->count($query_args, 'ATT_ID', true)
+				: $ATT_MDL->get_all($query_args);
+		} else {
+			$query_args[0]['status'] = array('IN', array('publish'));
+			$all_attendees = $count
+				? $ATT_MDL->count($query_args, 'ATT_ID', true)
+				: $ATT_MDL->get_all($query_args);
+		}
+		return $all_attendees;
+	}
+
+
+	/**
+	 * This is just taking care of resending the registration confirmation
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _resend_registration()
+	{
+		$this->_process_resend_registration();
+		$query_args = isset($this->_req_data['redirect_to'])
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
+			: array('action' => 'default');
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+	/**
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
+	 * to use when selecting registrations
+	 *
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
+	 *                                                     the query parameters from the request
+	 * @return void ends the request with a redirect or download
+	 */
+	public function _registrations_report_base($method_name_for_getting_query_params)
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page'        => 'espresso_batch',
+						'batch'       => 'file',
+						'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+						'filters'     => urlencode(
+							serialize(
+								call_user_func(
+									array($this, $method_name_for_getting_query_params),
+									EEH_Array::is_set(
+										$this->_req_data,
+										'filters',
+										array()
+									)
+								)
+							)
+						),
+						'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
+						'return_url'  => urlencode($this->_req_data['return_url']),
+					)
+				)
+			);
+		} else {
+			$new_request_args = array(
+				'export' => 'report',
+				'action' => 'registrations_report_for_event',
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+			);
+			$this->_req_data = array_merge($this->_req_data, $new_request_args);
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->export();
+			}
+		}
+	}
+
+
+	/**
+	 * Creates a registration report using only query parameters in the request
+	 *
+	 * @return void
+	 */
+	public function _registrations_report()
+	{
+		$this->_registrations_report_base('_get_registration_query_parameters');
+	}
+
+
+	public function _contact_list_export()
+	{
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export_attendees();
+		}
+	}
+
+
+	public function _contact_list_report()
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page'        => 'espresso_batch',
+						'batch'       => 'file',
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
+						'return_url'  => urlencode($this->_req_data['return_url']),
+					)
+				)
+			);
+		} else {
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->report_attendees();
+			}
+		}
+	}
+
+
+
+
+
+	/***************************************        ATTENDEE DETAILS        ***************************************/
+	/**
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _duplicate_attendee()
+	{
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
+		// verify we have necessary info
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
+					'event_espresso'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+			$query_args = array('action' => $action);
+			$this->_redirect_after_action('', '', '', $query_args, true);
+		}
+		// okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
+		$attendee = $registration->attendee();
+		// remove relation of existing attendee on registration
+		$registration->_remove_relation_to($attendee, 'Attendee');
+		// new attendee
+		$new_attendee = clone $attendee;
+		$new_attendee->set('ATT_ID', 0);
+		$new_attendee->save();
+		// add new attendee to reg
+		$registration->_add_relation_to($new_attendee, 'Attendee');
+		EE_Error::add_success(
+			esc_html__(
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
+				'event_espresso'
+			)
+		);
+		// redirect to edit page for attendee
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
+		$this->_redirect_after_action('', '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
+	 *
+	 * @param int     $post_id
+	 * @param WP_POST $post
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		$success = true;
+		$attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
+			? EEM_Attendee::instance()->get_one_by_ID($post_id)
+			: null;
+		// for attendee updates
+		if ($attendee instanceof EE_Attendee) {
+			// note we should only be UPDATING attendees at this point.
+			$updated_fields = array(
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
+			);
+			foreach ($updated_fields as $field => $value) {
+				$attendee->set($field, $value);
+			}
+
+			// process contact details metabox form handler (which will also save the attendee)
+			$contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
+			$success = $contact_details_form->process($this->_req_data);
+
+			$attendee_update_callbacks = apply_filters(
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
+				array()
+			);
+			foreach ($attendee_update_callbacks as $a_callback) {
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
+								'event_espresso'
+							),
+							$a_callback
+						)
+					);
+				}
+			}
+		}
+
+		if ($success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with updating the meta table data for the registration.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+	}
+
+
+	public function attendee_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+		remove_meta_box(
+			'postexcerpt',
+			esc_html__('Excerpt', 'event_espresso'),
+			'post_excerpt_meta_box',
+			$this->_cpt_routes[ $this->_req_action ],
+			'normal',
+			'core'
+		);
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core');
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
+			add_meta_box(
+				'postexcerpt',
+				esc_html__('Short Biography', 'event_espresso'),
+				'post_excerpt_meta_box',
+				$this->_cpt_routes[ $this->_req_action ],
+				'normal'
+			);
+		}
+		if (post_type_supports('espresso_attendees', 'comments')) {
+			add_meta_box(
+				'commentsdiv',
+				esc_html__('Notes on the Contact', 'event_espresso'),
+				'post_comment_meta_box',
+				$this->_cpt_routes[ $this->_req_action ],
+				'normal',
+				'core'
+			);
+		}
+		add_meta_box(
+			'attendee_contact_info',
+			esc_html__('Contact Info', 'event_espresso'),
+			array($this, 'attendee_contact_info'),
+			$this->_cpt_routes[ $this->_req_action ],
+			'side',
+			'core'
+		);
+		add_meta_box(
+			'attendee_details_address',
+			esc_html__('Address Details', 'event_espresso'),
+			array($this, 'attendee_address_details'),
+			$this->_cpt_routes[ $this->_req_action ],
+			'normal',
+			'core'
+		);
+		add_meta_box(
+			'attendee_registrations',
+			esc_html__('Registrations for this Contact', 'event_espresso'),
+			array($this, 'attendee_registrations_meta_box'),
+			$this->_cpt_routes[ $this->_req_action ],
+			'normal',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Metabox for attendee contact info
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee contact info ( and form )
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws DomainException
+	 */
+	public function attendee_contact_info($post)
+	{
+		// get attendee object ( should already have it )
+		$form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
+		$form->enqueueStylesAndScripts();
+		echo $form->display();
+	}
+
+
+	/**
+	 * Return form handler for the contact details metabox
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return AttendeeContactDetailsMetaboxFormHandler
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
+	{
+		return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
+	}
+
+
+	/**
+	 * Metabox for attendee details
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @throws DomainException
+	 */
+	public function attendee_address_details($post)
+	{
+		// get attendee object (should already have it)
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
+		$this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
+						'QST_system'       => 'admin-state',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'STA_ID',
+					'input_name'     => 'STA_ID',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
+						'QST_system'       => 'admin-country',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'CNT_ISO',
+					'input_name'     => 'CNT_ISO',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$template =
+			REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 *        _attendee_details
+	 *
+	 * @access protected
+	 * @param $post
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function attendee_registrations_meta_box($post)
+	{
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
+		$template =
+			REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * add in the form fields for the attendee edit
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string html for new form.
+	 * @throws DomainException
+	 */
+	public function after_title_form_fields($post)
+	{
+		if ($post->post_type == 'espresso_attendees') {
+			$template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+			$template_args['attendee'] = $this->_cpt_model_obj;
+			EEH_Template::display_template($template, $template_args);
+		}
+	}
+
+
+	/**
+	 *        _trash_or_restore_attendee
+	 *
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_attendees($trash = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ATT_MDL = EEM_Attendee::instance();
+		$success = 1;
+		// Checkboxes
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
+				if (! $updated) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
+			// get attendee
+			$att = $ATT_MDL->get_one_by_ID($ATT_ID);
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
+			$updated = $att->save();
+			if (! $updated) {
+				$success = 0;
+			}
+		}
+		$what = $success > 1
+			? esc_html__('Contacts', 'event_espresso')
+			: esc_html__('Contact', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
+	}
 }

Spacing +109 added lines, -109 removed lines

@@ -65,7 +65,7 @@ 
         // when adding a new registration...
         if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
             EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
+            if ( ! isset($this->_req_data['processing_registration'])
                 || absint($this->_req_data['processing_registration']) !== 1
             ) {
                 // and it's NOT the attendee information reg step
@@ -658,7 +658,7 @@ 
         // style
         wp_register_style(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
+            REG_ASSETS_URL.'espresso_registrations_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -666,7 +666,7 @@ 
         // script
         wp_register_script(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
+            REG_ASSETS_URL.'espresso_registrations_admin.js',
             array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -704,7 +704,7 @@ 
         wp_dequeue_style('espresso_reg');
         wp_register_style(
             'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
+            REG_ASSETS_URL.'espresso_attendees_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -716,7 +716,7 @@ 
     {
         wp_register_script(
             'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
+            REG_ASSETS_URL.'spco_for_admin.js',
             array('underscore', 'jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -950,7 +950,7 @@ 
         }
         $sc_items = array(
             'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_approved,
                     false,
@@ -958,7 +958,7 @@ 
                 ),
             ),
             'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_pending_payment,
                     false,
@@ -966,7 +966,7 @@ 
                 ),
             ),
             'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_wait_list,
                     false,
@@ -974,7 +974,7 @@ 
                 ),
             ),
             'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_incomplete,
                     false,
@@ -982,7 +982,7 @@ 
                 ),
             ),
             'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_not_approved,
                     false,
@@ -990,7 +990,7 @@ 
                 ),
             ),
             'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_declined,
                     false,
@@ -998,7 +998,7 @@ 
                 ),
             ),
             'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_cancelled,
                     false,
@@ -1033,13 +1033,13 @@ 
                         'event_espresso'
                     ),
                     '<h3 style="line-height:1.5em;">',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         array(
                             'action' => 'edit_attendee',
                             'post'   => $ATT_ID,
                         ),
                         REG_ADMIN_URL
-                    ) . '">' . $attendee->full_name() . '</a>',
+                    ).'">'.$attendee->full_name().'</a>',
                     '</h3>'
                 );
             }
@@ -1050,7 +1050,7 @@ 
                 'espresso_registrations_new_registration',
                 $EVT_ID
             )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+                $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                     'new_registration',
                     'add-registrant',
                     array('event_id' => $EVT_ID),
@@ -1090,7 +1090,7 @@ 
                 $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
                 $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
                 $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+                $this->_template_args['admin_page_header'] .= ' ( '.$datetime->start_date().' )';
                 $this->_template_args['admin_page_header'] .= '</span></h3>';
             }
         }
@@ -1116,7 +1116,7 @@ 
             return true;
         }
         $REG = EEM_Registration::instance();
-        $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
+        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
         if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
             return true;
         } else {
@@ -1200,7 +1200,7 @@ 
             'caps'                     => EEM_Registration::caps_read_admin,
             'default_where_conditions' => 'this_model_only',
         );
-        if (! $count) {
+        if ( ! $count) {
             $query_params = array_merge(
                 $query_params,
                 $this->_get_orderby_for_registrations_query(),
@@ -1221,7 +1221,7 @@ 
     protected function addAttendeeIdToWhereConditions(array $request)
     {
         $where = array();
-        if (! empty($request['ATT_ID'])) {
+        if ( ! empty($request['ATT_ID'])) {
             $where['ATT_ID'] = absint($request['ATT_ID']);
         }
         return $where;
@@ -1237,7 +1237,7 @@ 
     protected function _add_event_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['event_id'])) {
+        if ( ! empty($request['event_id'])) {
             $where['EVT_ID'] = absint($request['event_id']);
         }
         return $where;
@@ -1253,7 +1253,7 @@ 
     protected function _add_category_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
+        if ( ! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
             $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
         }
         return $where;
@@ -1269,10 +1269,10 @@ 
     protected function _add_datetime_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['datetime_id'])) {
+        if ( ! empty($request['datetime_id'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
         }
-        if (! empty($request['DTT_ID'])) {
+        if ( ! empty($request['DTT_ID'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
         }
         return $where;
@@ -1298,7 +1298,7 @@ 
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
+        if ( ! empty($registration_status)) {
             $where['STS_ID'] = $registration_status;
         } else {
             // make sure we exclude incomplete registrations, but only if not trashed.
@@ -1341,12 +1341,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 00:00:00',
+                        $now.' 00:00:00',
                         'Y-m-d H:i:s'
                     ),
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 23:59:59',
+                        $now.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1359,12 +1359,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
+                        $current_year_and_month.'-01 00:00:00',
                         'Y-m-d H:i:s'
                     ),
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+                        $current_year_and_month.'-'.$days_this_month.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1379,18 +1379,18 @@ 
                 : '';
             // if there is not a month or year then we can't go further
             if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+                $days_in_month = date('t', strtotime($year_requested.'-'.$month_requested.'-'.'01'));
                 $where['REG_date'] = array(
                     'BETWEEN',
                     array(
                         EEM_Registration::instance()->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
+                            $year_requested.'-'.$month_requested.'-01 00:00:00',
                             'Y-m-d H:i:s'
                         ),
                         EEM_Registration::instance()->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+                            $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59',
                             'Y-m-d H:i:s'
                         ),
                     ),
@@ -1410,8 +1410,8 @@ 
     protected function _add_search_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
+        if ( ! empty($request['s'])) {
+            $search_string = '%'.sanitize_text_field($request['s']).'%';
             $where['OR*search_conditions'] = array(
                 'Event.EVT_name'                          => array('LIKE', $search_string),
                 'Event.EVT_desc'                          => array('LIKE', $search_string),
@@ -1647,7 +1647,7 @@ 
                 )
                 : '';
             // grab header
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+            $template_path = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php';
             $this->_template_args['REG_ID'] = $this->_registration->ID();
             $this->_template_args['admin_page_header'] = EEH_Template::display_template(
                 $template_path,
@@ -1784,7 +1784,7 @@ 
                             EEH_HTML::strong(
                                 $this->_registration->pretty_status(),
                                 '',
-                                'status-' . $this->_registration->status_ID(),
+                                'status-'.$this->_registration->status_ID(),
                                 'line-height: 1em; font-size: 1.5em; font-weight: bold;'
                             )
                         )
@@ -1839,14 +1839,14 @@ 
     protected function _get_reg_statuses()
     {
         $reg_status_array = EEM_Registration::instance()->reg_status_array();
-        unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
+        unset($reg_status_array[EEM_Registration::status_id_incomplete]);
         // get current reg status
         $current_status = $this->_registration->status_ID();
         // is registration for free event? This will determine whether to display the pending payment option
         if ($current_status !== EEM_Registration::status_id_pending_payment
             && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
         ) {
-            unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
+            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
         }
         return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
     }
@@ -1938,7 +1938,7 @@ 
         $success = false;
         // typecast $REG_IDs
         $REG_IDs = (array) $REG_IDs;
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             $success = true;
             // set default status if none is passed
             $status = $status ? $status : EEM_Registration::status_id_pending_payment;
@@ -2086,7 +2086,7 @@ 
             $action,
             $notify
         );
-        $method = $action . '_registration';
+        $method = $action.'_registration';
         if (method_exists($this, $method)) {
             $this->$method($notify);
         }
@@ -2317,7 +2317,7 @@ 
         $this->_template_args['REG_ID'] = $this->_registration->ID();
         $this->_template_args['event_id'] = $this->_registration->event_ID();
         $template_path =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+            REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2350,7 +2350,7 @@ 
             $this->_template_args['reg_questions_form_action'] = 'edit_registration';
             $this->_template_args['REG_ID'] = $this->_registration->ID();
             $template_path =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+                REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
             echo EEH_Template::display_template($template_path, $this->_template_args, true);
         }
     }
@@ -2367,7 +2367,7 @@ 
     public function form_before_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2392,7 +2392,7 @@ 
     public function form_after_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2430,7 +2430,7 @@ 
     public function form_form_field_label_wrap($label)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2440,7 +2440,7 @@ 
         return '
 			<tr>
 				<th>
-					' . $label . '
+					' . $label.'
 				</th>';
     }
 
@@ -2456,7 +2456,7 @@ 
     public function form_form_field_input__wrap($input)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2465,7 +2465,7 @@ 
         );
         return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
-					' . $input . '
+					' . $input.'
 				</td>
 			</tr>';
     }
@@ -2509,8 +2509,8 @@ 
      */
     protected function _get_reg_custom_questions_form($REG_ID)
     {
-        if (! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+        if ( ! $this->_reg_custom_questions_form) {
+            require_once(REG_ADMIN.'form_sections'.DS.'EE_Registration_Custom_Questions_Form.form.php');
             $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
                 EEM_Registration::instance()->get_one_by_ID($REG_ID)
             );
@@ -2533,7 +2533,7 @@ 
      */
     private function _save_reg_custom_questions_form($REG_ID = false)
     {
-        if (! $REG_ID) {
+        if ( ! $REG_ID) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No registration ID was received.',
@@ -2624,30 +2624,30 @@ 
                     ? $registration->attendee()
                     : EEM_Attendee::instance()
                                   ->create_default_object();
-                $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID();
-                $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname();
-                $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname();
-                $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email();
-                $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode(
+                $this->_template_args['attendees'][$att_nmbr]['STS_ID'] = $registration->status_ID();
+                $this->_template_args['attendees'][$att_nmbr]['fname'] = $attendee->fname();
+                $this->_template_args['attendees'][$att_nmbr]['lname'] = $attendee->lname();
+                $this->_template_args['attendees'][$att_nmbr]['email'] = $attendee->email();
+                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
+                $this->_template_args['attendees'][$att_nmbr]['address'] = implode(
                     ', ',
                     $attendee->full_address_as_array()
                 );
-                $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce(
+                $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(
                     array(
                         'action' => 'edit_attendee',
                         'post'   => $attendee->ID(),
                     ),
                     REG_ADMIN_URL
                 );
-                $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event
+                $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj() instanceof EE_Event
                     ? $registration->event_obj()->name()
                     : '';
                 $att_nmbr++;
             }
             $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
         }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2671,11 +2671,11 @@ 
         // now let's determine if this is not the primary registration.  If it isn't then we set the
         // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
         // primary registration object (that way we know if we need to show create button or not)
-        if (! $this->_registration->is_primary_registrant()) {
+        if ( ! $this->_registration->is_primary_registrant()) {
             $primary_registration = $this->_registration->get_primary_registration();
             $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
                 : null;
-            if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
                 // in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
                 // custom attendee object so let's not worry about the primary reg.
                 $primary_registration = null;
@@ -2709,7 +2709,7 @@ 
             ) : '';
         $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
         $this->_template_args['att_check'] = $att_check;
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2747,7 +2747,7 @@ 
         $success = 0;
         $overwrite_msgs = false;
         // Checkboxes
-        if (! is_array($this->_req_data['_REG_ID'])) {
+        if ( ! is_array($this->_req_data['_REG_ID'])) {
             $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
         }
         $reg_count = count($this->_req_data['_REG_ID']);
@@ -2756,7 +2756,7 @@ 
             /** @var EE_Registration $REG */
             $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
             $payments = $REG->registration_payments();
-            if (! empty($payments)) {
+            if ( ! empty($payments)) {
                 $name = $REG->attendee() instanceof EE_Attendee
                     ? $REG->attendee()->full_name()
                     : esc_html__('Unknown Attendee', 'event_espresso');
@@ -2817,17 +2817,17 @@ 
         $REG_MDL = EEM_Registration::instance();
         $success = 1;
         // Checkboxes
-        if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
+        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
             // if array has more than one element than success message should be plural
             $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
             // cycle thru checkboxes
             while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
                 $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if (! $REG instanceof EE_Registration) {
+                if ( ! $REG instanceof EE_Registration) {
                     continue;
                 }
                 $deleted = $this->_delete_registration($REG);
-                if (! $deleted) {
+                if ( ! $deleted) {
                     $success = 0;
                 }
             }
@@ -2836,7 +2836,7 @@ 
             $REG_ID = $this->_req_data['_REG_ID'];
             $REG = $REG_MDL->get_one_by_ID($REG_ID);
             $deleted = $this->_delete_registration($REG);
-            if (! $deleted) {
+            if ( ! $deleted) {
                 $success = 0;
             }
         }
@@ -2870,11 +2870,11 @@ 
         $REGS = $TXN->get_many_related('Registration');
         $all_trashed = true;
         foreach ($REGS as $registration) {
-            if (! $registration->get('REG_deleted')) {
+            if ( ! $registration->get('REG_deleted')) {
                 $all_trashed = false;
             }
         }
-        if (! $all_trashed) {
+        if ( ! $all_trashed) {
             EE_Error::add_error(
                 esc_html__(
                     'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
@@ -2933,7 +2933,7 @@ 
      */
     public function new_registration()
     {
-        if (! $this->_set_reg_event()) {
+        if ( ! $this->_set_reg_event()) {
             throw new EE_Error(
                 esc_html__(
                     'Unable to continue with registering because there is no Event ID in the request',
@@ -2943,8 +2943,8 @@ 
         }
         EE_Registry::instance()->REQ->set_espresso_page(true);
         // gotta start with a clean slate if we're not coming here via ajax
-        if (! defined('DOING_AJAX')
-            && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
+        if ( ! defined('DOING_AJAX')
+            && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
         ) {
             EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
         }
@@ -2977,7 +2977,7 @@ 
         }
         // grab header
         $template_path =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_template_args,
@@ -3018,7 +3018,7 @@ 
                 '</b>'
             );
             return '
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
+	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -3086,7 +3086,7 @@ 
         // we come back to the process_registration_step route.
         $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
         return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php',
             $template_args,
             true
         );
@@ -3108,8 +3108,8 @@ 
         if (is_object($this->_reg_event)) {
             return true;
         }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
-        if (! $EVT_ID) {
+        $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+        if ( ! $EVT_ID) {
             return false;
         }
         $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
@@ -3141,8 +3141,8 @@ 
         $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
         // if doing ajax then we need to verify the nonce
         if (defined('DOING_AJAX')) {
-            $nonce = isset($this->_req_data[ $this->_req_nonce ])
-                ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : '';
+            $nonce = isset($this->_req_data[$this->_req_nonce])
+                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
             $this->_verify_nonce($nonce, $this->_req_nonce);
         }
         switch ($step) {
@@ -3178,7 +3178,7 @@ 
                 }
                 break;
             case 'questions':
-                if (! isset(
+                if ( ! isset(
                     $this->_req_data['txn_reg_status_change'],
                     $this->_req_data['txn_reg_status_change']['send_notifications']
                 )
@@ -3193,7 +3193,7 @@ 
                         $grand_total->save_this_and_descendants_to_txn();
                     }
                 }
-                if (! $transaction instanceof EE_Transaction) {
+                if ( ! $transaction instanceof EE_Transaction) {
                     $query_args = array(
                         'action'                  => 'new_registration',
                         'processing_registration' => 2,
@@ -3216,7 +3216,7 @@ 
                     }
                 }
                 // maybe update status, and make sure to save transaction if not done already
-                if (! $transaction->update_status_based_on_total_paid()) {
+                if ( ! $transaction->update_status_based_on_total_paid()) {
                     $transaction->save();
                 }
                 EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
@@ -3299,7 +3299,7 @@ 
     public function get_attendees($per_page, $count = false, $trash = false)
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+        require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php');
         $ATT_MDL = EEM_Attendee::instance();
         $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
         switch ($this->_req_data['orderby']) {
@@ -3338,8 +3338,8 @@ 
             ? $this->_req_data['perpage']
             : $per_page;
         $_where = array();
-        if (! empty($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+        if ( ! empty($this->_req_data['s'])) {
+            $sstr = '%'.$this->_req_data['s'].'%';
             $_where['OR'] = array(
                 'Registration.Event.EVT_name'       => array('LIKE', $sstr),
                 'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
@@ -3366,7 +3366,7 @@ 
             'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
             'limit'         => $limit,
         );
-        if (! $count) {
+        if ( ! $count) {
             $query_args['order_by'] = array($orderby => $sort);
         }
         if ($trash) {
@@ -3409,7 +3409,7 @@ 
      */
     public function _registrations_report_base($method_name_for_getting_query_params)
     {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             wp_redirect(
                 EE_Admin_Page::add_query_args_and_nonce(
                     array(
@@ -3441,8 +3441,8 @@ 
                 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
             );
             $this->_req_data = array_merge($this->_req_data, $new_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($this->_req_data);
                 $EE_Export->export();
             }
@@ -3463,8 +3463,8 @@ 
 
     public function _contact_list_export()
     {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export_attendees();
         }
@@ -3473,7 +3473,7 @@ 
 
     public function _contact_list_report()
     {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             wp_redirect(
                 EE_Admin_Page::add_query_args_and_nonce(
                     array(
@@ -3485,8 +3485,8 @@ 
                 )
             );
         } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($this->_req_data);
                 $EE_Export->report_attendees();
             }
@@ -3572,7 +3572,7 @@ 
             $updated_fields = array(
                 'ATT_fname'     => $this->_req_data['ATT_fname'],
                 'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+                'ATT_full_name' => $this->_req_data['ATT_fname'].' '.$this->_req_data['ATT_lname'],
                 'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
                 'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
                 'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
@@ -3648,17 +3648,17 @@ 
             'postexcerpt',
             esc_html__('Excerpt', 'event_espresso'),
             'post_excerpt_meta_box',
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'normal',
             'core'
         );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core');
+        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
         if (post_type_supports('espresso_attendees', 'excerpt')) {
             add_meta_box(
                 'postexcerpt',
                 esc_html__('Short Biography', 'event_espresso'),
                 'post_excerpt_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
+                $this->_cpt_routes[$this->_req_action],
                 'normal'
             );
         }
@@ -3667,7 +3667,7 @@ 
                 'commentsdiv',
                 esc_html__('Notes on the Contact', 'event_espresso'),
                 'post_comment_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
+                $this->_cpt_routes[$this->_req_action],
                 'normal',
                 'core'
             );
@@ -3676,7 +3676,7 @@ 
             'attendee_contact_info',
             esc_html__('Contact Info', 'event_espresso'),
             array($this, 'attendee_contact_info'),
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'side',
             'core'
         );
@@ -3684,7 +3684,7 @@ 
             'attendee_details_address',
             esc_html__('Address Details', 'event_espresso'),
             array($this, 'attendee_address_details'),
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'normal',
             'core'
         );
@@ -3692,7 +3692,7 @@ 
             'attendee_registrations',
             esc_html__('Registrations for this Contact', 'event_espresso'),
             array($this, 'attendee_registrations_meta_box'),
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'normal',
             'high'
         );
@@ -3793,7 +3793,7 @@ 
             )
         );
         $template =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+            REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3812,7 +3812,7 @@ 
         $this->_template_args['attendee'] = $this->_cpt_model_obj;
         $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
         $template =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+            REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3827,7 +3827,7 @@ 
     public function after_title_form_fields($post)
     {
         if ($post->post_type == 'espresso_attendees') {
-            $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+            $template = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php';
             $template_args['attendee'] = $this->_cpt_model_obj;
             EEH_Template::display_template($template, $template_args);
         }
@@ -3851,14 +3851,14 @@ 
         $ATT_MDL = EEM_Attendee::instance();
         $success = 1;
         // Checkboxes
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element than success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru checkboxes
             while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
                 $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
                     : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
-                if (! $updated) {
+                if ( ! $updated) {
                     $success = 0;
                 }
             }
@@ -3869,7 +3869,7 @@ 
             $att = $ATT_MDL->get_one_by_ID($ATT_ID);
             $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
             $updated = $att->save();
-            if (! $updated) {
+            if ( ! $updated) {
                 $success = 0;
             }
         }

core/db_classes/EE_Message.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -697,7 +697,7 @@
     /**
      * Gets any error message.
      *
-     * @return mixed|null
+     * @return string
      */
     public function error_message()
     {

Indentation +867 added lines, -867 removed lines

@@ -10,875 +10,875 @@
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid = $message_resource_manager->is_message_type_active_for_messenger(
-                $this->messenger(),
-                $this->message_type()
-            );
-            if (! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'
-                        ),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
-            : str_replace(
-                '_',
-                ' ',
-                $this->message_type()
-            );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
-            : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed:
-            case EEM_Message::status_debug_only:
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent:
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default:
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the
-     * status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID(EEM_Message::status_messenger_executing);
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		// if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if (! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid = $message_resource_manager->is_message_type_active_for_messenger(
+				$this->messenger(),
+				$this->message_type()
+			);
+			if (! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'
+						),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type
+			? $message_type->label[ $label_type ]
+			: str_replace(
+				'_',
+				' ',
+				$this->message_type()
+			);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts = $message_resource_manager->get_all_contexts();
+		return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if (! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
+			: $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed:
+			case EEM_Message::status_debug_only:
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent:
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default:
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the
+	 * status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID(EEM_Message::status_messenger_executing);
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -51,7 +51,7 @@ 
     {
         $has_object = parent::_check_for_object($props_n_values, __CLASS__);
         // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
+        if ( ! $has_object) {
             EE_Registry::instance()->load_helper('URL');
             $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
         }
@@ -219,7 +219,7 @@ 
     {
         $label_type = $plural ? 'plural' : 'singular';
         $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
     }
 
 
@@ -336,7 +336,7 @@ 
                 $this->messenger(),
                 $this->message_type()
             );
-            if (! $valid && $throw_exceptions) {
+            if ( ! $valid && $throw_exceptions) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -366,7 +366,7 @@ 
         $label_type = $plural ? 'plural' : 'singular';
         $message_type = $this->message_type_object();
         return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
+            ? $message_type->label[$label_type]
             : str_replace(
                 '_',
                 ' ',
@@ -397,7 +397,7 @@ 
         /** @type EE_Message_Resource_Manager $message_resource_manager */
         $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
     }
 
 
@@ -452,7 +452,7 @@ 
      */
     public function recipient_object()
     {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
+        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
             return null;
         }
 
@@ -736,13 +736,13 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_pack)) {
+        if ( ! empty($this->template_pack)) {
             return $this->template_pack;
         }
         /** @type EE_Message_Template_Group $grp */
         $grp = $this->get_first_related('Message_Template_Group');
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -768,7 +768,7 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_variation)) {
+        if ( ! empty($this->template_variation)) {
             return $this->template_variation;
         }
 
@@ -776,7 +776,7 @@ 
         $grp = $this->get_first_related('Message_Template_Group');
 
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(

core/libraries/messages/EE_Messages_Queue.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -603,7 +603,7 @@
      * @param EE_Message      $message
      * @param EE_messenger    $messenger
      * @param EE_message_type $message_type
-     * @param                 $test_send
+     * @param                 boolean $test_send
      * @return bool   true means all went well, false means, not so much.
      */
     protected function _do_preview(

Indentation +690 added lines, -690 removed lines

@@ -14,694 +14,694 @@
 {
 
 
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = array();
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param \EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param  bool      $preview      Whether this EE_Message represents a preview or not.
-     * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            // get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_generating)) {
-            return false;
-        }
-
-        // lock batch generation to prevent race conditions.
-        $this->lock_queue(EE_Messages_Queue::action_generating);
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => EEM_Message::status_incomplete),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        );
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if (! $messages) {
-            return false; // nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     */
-    public function get_to_send_batch_and_send()
-    {
-        $rate_limit = $this->get_rate_limit();
-        if ($rate_limit < 1
-            || $this->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        );
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        // any to send?
-        if (! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        $queue_count = 0;
-
-        // add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $queue_count++;
-                $this->add($message);
-            }
-        }
-
-        // send messages  (this also updates the rate limit)
-        $this->execute();
-
-        // release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        // update rate limit
-        $this->set_rate_limit($queue_count);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param   string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param   string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_option($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return array(
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        );
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
-     * Return true when batch methods should not be used; returns false when they can be.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return true;
-        }
-        $lock = (int) get_option($this->_get_lock_key($type), 0);
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                $lock > time(),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
-     * @return int
-     */
-    protected function get_rate_limit($return_expiry = false)
-    {
-        $stored_rate_info = get_option($this->_get_rate_limit_key(), array());
-        $rate_limit = isset($stored_rate_info[0])
-            ? (int) $stored_rate_info[0]
-            : 0;
-        $expiry = isset($stored_rate_info[1])
-            ? (int) $stored_rate_info[1]
-            : 0;
-        // set the default for tracking?
-        if (empty($stored_rate_info) || time() > $expiry) {
-            $expiry = $this->_get_rate_limit_expiry();
-            $rate_limit = $this->_default_rate_limit();
-            update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
-        }
-        return $return_expiry ? $expiry : $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    protected function set_rate_limit($batch_completed)
-    {
-        // first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $expiry = $this->get_rate_limit(true);
-        $new_limit  = $rate_limit - $batch_completed;
-        // updating the transient option directly to avoid resetting the expiry.
-
-        update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        // determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            // if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            // queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param   bool     $save                    Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param   bool|int $by_priority             When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = array();
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = array();
-            /** @type EE_Message $message */
-            $message = $this->_message_repository->current();
-            // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    __('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    __('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            // add modified time
-            $message->set_modified(time());
-            // we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            // out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        // do actions for sending messenger if it differs from generating messenger and swap values.
-        if ($sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
-            }
-            // if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array|string $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : array($status);
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array) $error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = __(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = array();
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param \EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param  bool      $preview      Whether this EE_Message represents a preview or not.
+	 * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			// get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
+			return false;
+		}
+
+		// lock batch generation to prevent race conditions.
+		$this->lock_queue(EE_Messages_Queue::action_generating);
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => EEM_Message::status_incomplete),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		);
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if (! $messages) {
+			return false; // nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		$rate_limit = $this->get_rate_limit();
+		if ($rate_limit < 1
+			|| $this->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		);
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		// any to send?
+		if (! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		$queue_count = 0;
+
+		// add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$queue_count++;
+				$this->add($message);
+			}
+		}
+
+		// send messages  (this also updates the rate limit)
+		$this->execute();
+
+		// release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		// update rate limit
+		$this->set_rate_limit($queue_count);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param   string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param   string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_option($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return array(
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		);
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
+	 * Return true when batch methods should not be used; returns false when they can be.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return true;
+		}
+		$lock = (int) get_option($this->_get_lock_key($type), 0);
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				$lock > time(),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
+	 * @return int
+	 */
+	protected function get_rate_limit($return_expiry = false)
+	{
+		$stored_rate_info = get_option($this->_get_rate_limit_key(), array());
+		$rate_limit = isset($stored_rate_info[0])
+			? (int) $stored_rate_info[0]
+			: 0;
+		$expiry = isset($stored_rate_info[1])
+			? (int) $stored_rate_info[1]
+			: 0;
+		// set the default for tracking?
+		if (empty($stored_rate_info) || time() > $expiry) {
+			$expiry = $this->_get_rate_limit_expiry();
+			$rate_limit = $this->_default_rate_limit();
+			update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
+		}
+		return $return_expiry ? $expiry : $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	protected function set_rate_limit($batch_completed)
+	{
+		// first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$expiry = $this->get_rate_limit(true);
+		$new_limit  = $rate_limit - $batch_completed;
+		// updating the transient option directly to avoid resetting the expiry.
+
+		update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		// determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			// if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			// queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param   bool     $save                    Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param   bool|int $by_priority             When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = array();
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = array();
+			/** @type EE_Message $message */
+			$message = $this->_message_repository->current();
+			// only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			// add modified time
+			$message->set_modified(time());
+			// we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			// out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		// do actions for sending messenger if it differs from generating messenger and swap values.
+		if ($sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			// set hook for message type (but only if not using another messenger to send).
+			if (! isset($this->_did_hook[ $message_type->name ])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[ $message_type->name ] = 1;
+			}
+			// if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array|string $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : array($status);
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if (! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array) $error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = __(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -171,9 +171,9 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         );
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
-        if (! $messages) {
+        if ( ! $messages) {
             return false; // nothing to generate
         }
 
@@ -227,7 +227,7 @@ 
 
 
         // any to send?
-        if (! $messages_to_send) {
+        if ( ! $messages_to_send) {
             $this->unlock_queue(EE_Messages_Queue::action_sending);
             return false;
         }
@@ -283,7 +283,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -355,7 +355,7 @@ 
      */
     public function is_locked($type = EE_Messages_Queue::action_generating)
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return true;
         }
         $lock = (int) get_option($this->_get_lock_key($type), 0);
@@ -505,7 +505,7 @@ 
             /** @type EE_Message $message */
             $message = $this->_message_repository->current();
             // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -515,13 +515,13 @@ 
                 continue;
             }
             // error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     __('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     __('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -582,9 +582,9 @@ 
         // send using messenger, but double check objects
         if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
             // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
+            if ( ! isset($this->_did_hook[$message_type->name])) {
                 $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
+                $this->_did_hook[$message_type->name] = 1;
             }
             // if preview then use preview method
             return $this->_message_repository->is_preview()
@@ -635,7 +635,7 @@ 
         $test_send
     ) {
         if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
+            if ( ! $test_send) {
                 $message->set_content($preview);
             }
             $message->set_STS_ID(EEM_Message::status_sent);
@@ -700,7 +700,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }

core/db_models/fields/EE_Field_With_Model_Name.php

Spacing +2 added lines, -2 removed lines

@@ -70,10 +70,10 @@
         $model_names = array();
         if (is_array($this->_model_name_pointed_to)) {
             foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
+                $model_names[] = "EE_".$model_name;
             }
         } else {
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
+            $model_names = array("EE_".$this->_model_name_pointed_to);
         }
         return $model_names;
     }

Indentation +79 added lines, -79 removed lines

@@ -8,88 +8,88 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string or array
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string or array
+	 */
+	protected $_model_name_pointed_to;
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @deprecated since version 4.6.7
-     * @return mixed string or array of strings
-     */
-    public function get_model_name_pointed_to()
-    {
-        EE_Error::doing_it_wrong(
-            'get_model_name_pointed_to',
-            __(
-                'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @deprecated since version 4.6.7
+	 * @return mixed string or array of strings
+	 */
+	public function get_model_name_pointed_to()
+	{
+		EE_Error::doing_it_wrong(
+			'get_model_name_pointed_to',
+			__(
+				'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return $this->_model_name_pointed_to;
+	}
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return array of model names pointed to by this field
-     */
-    public function get_model_names_pointed_to()
-    {
-        if (is_array($this->_model_name_pointed_to)) {
-            return $this->_model_name_pointed_to;
-        } else {
-            return array($this->_model_name_pointed_to);
-        }
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return array of model names pointed to by this field
+	 */
+	public function get_model_names_pointed_to()
+	{
+		if (is_array($this->_model_name_pointed_to)) {
+			return $this->_model_name_pointed_to;
+		} else {
+			return array($this->_model_name_pointed_to);
+		}
+	}
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return array
-     */
-    public function get_model_class_names_pointed_to()
-    {
-        $model_names = array();
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return array
+	 */
+	public function get_model_class_names_pointed_to()
+	{
+		$model_names = array();
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = array("EE_" . $this->_model_name_pointed_to);
+		}
+		return $model_names;
+	}
 
-    public function is_model_obj_of_type_pointed_to($model_obj_or_ID)
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj_or_ID instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	public function is_model_obj_of_type_pointed_to($model_obj_or_ID)
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/db_models/relations/EE_Model_Relation_Base.php

Doc Comments +5 added lines, -5 removed lines

@@ -133,9 +133,9 @@ 
 
     /**
      * @param        $other_table
-     * @param        $other_table_alias
+     * @param        string $other_table_alias
      * @param        $other_table_column
-     * @param        $this_table_alias
+     * @param        string $this_table_alias
      * @param        $this_table_join_column
      * @param string $extra_join_sql
      * @return string
@@ -189,7 +189,7 @@ 
      * Alters the $query_params to disable default where conditions, unless otherwise specified
      *
      * @param string $query_params
-     * @return array
+     * @return string
      */
     protected function _disable_default_where_conditions_on_query_param($query_params)
     {
@@ -206,7 +206,7 @@ 
      * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
      * model objects will only be soft-deleted.
      *
-     * @param EE_Base_Class|int|string $model_object_or_id
+     * @param EE_Base_Class|null $model_object_or_id
      * @param array                    $query_params
      * @return int of how many related models got deleted
      * @throws \EE_Error
@@ -237,7 +237,7 @@ 
      * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
      * model objects will only be soft-deleted.
      *
-     * @param EE_Base_Class|int|string $model_object_or_id
+     * @param EE_Base_Class|null $model_object_or_id
      * @param array                    $query_params
      * @return int of how many related models got deleted
      * @throws \EE_Error

Spacing +7 added lines, -7 removed lines

@@ -156,7 +156,7 @@ 
         $this_table_join_column,
         $extra_join_sql = ''
     ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+        return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
     }
 
 
@@ -190,7 +190,7 @@ 
                                                              . "."
                                                              . $this->get_this_model()->get_primary_key_field()->get_name();
         $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+        $query_params[0][$query_param_where_this_model_pk] = $model_object_id;
         return $this->get_other_model()->get_all($query_params);
     }
 
@@ -203,7 +203,7 @@ 
      */
     protected function _disable_default_where_conditions_on_query_param($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'none';
         }
         return $query_params;
@@ -233,7 +233,7 @@ 
                 $model_object_or_id
             );
             /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
+            if ( ! $delete_is_blocked) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $related_model_object->delete();
                 $deleted_count++;
@@ -269,7 +269,7 @@ 
             if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $deleted_count++;
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $related_model_object->delete_permanently();
                 } else {
                     // delete is blocked
@@ -278,7 +278,7 @@ 
                 }
             } else {
                 // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $this->remove_relation_to($model_object_or_id, $related_model_object);
                     $related_model_object->delete();
                     $deleted_count++;
@@ -302,7 +302,7 @@ 
         if ($model_object_or_id instanceof EE_Base_Class) {
             $model_object_id = $model_object_or_id->ID();
         }
-        if (! $model_object_id) {
+        if ( ! $model_object_id) {
             throw new EE_Error(sprintf(
                 __(
                     "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",

Indentation +497 added lines, -497 removed lines

@@ -15,502 +15,502 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_this_model_name;
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_other_model_name;
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected $_blocking_delete_error_message;
-
-    protected $_blocking_delete = false;
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes, $blocking_delete_error_message)
-    {
-        $this->_blocking_delete               = $block_deletes;
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     * @throws EE_Error
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-        if (is_string($this->_blocking_delete)) {
-            throw new EE_Error(sprintf(
-                __(
-                    "When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $this_model_name,
-                $other_model_name,
-                $this->_blocking_delete
-            ));
-        }
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     */
-    public function get_this_model()
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     */
-    public function get_other_model()
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        $modelInstance->set_timezone($this->_timezone);
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string $timezone timezone to set.
-     */
-    public function set_timezone($timezone)
-    {
-        if ($timezone !== null) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param        $other_table
-     * @param        $other_table_alias
-     * @param        $other_table_column
-     * @param        $this_table_alias
-     * @param        $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        $other_table,
-        $other_table_alias,
-        $other_table_column,
-        $this_table_alias,
-        $this_table_join_column,
-        $extra_join_sql = ''
-    ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
-     * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1'
-            );
-        }
-        $query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
-        $query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
-                                                             . "."
-                                                             . $this->get_this_model()->get_primary_key_field()->get_name();
-        $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param string $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_all_related($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
-     * @throws EE_Error
-     * @return int
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(sprintf(
-                __(
-                    "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                    "event_espresso"
-                ),
-                $this->get_other_model()->get_this_model_name(),
-                $this->get_this_model()->get_this_model_name()
-            ));
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement($model_relation_chain);
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $extra_join_model_fields_n_values
-     * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        $extra_join_model_fields_n_values = array()
-    );
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $where_query
-     * @return bool
-     */
-    abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function remove_relations($this_obj_or_id, $where_query_param = array())
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
-        $objs_removed   = array();
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist()
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     */
-    public function get_deletion_error_message()
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_this_model_name;
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_other_model_name;
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected $_blocking_delete_error_message;
+
+	protected $_blocking_delete = false;
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes, $blocking_delete_error_message)
+	{
+		$this->_blocking_delete               = $block_deletes;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+		if (is_string($this->_blocking_delete)) {
+			throw new EE_Error(sprintf(
+				__(
+					"When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
+					"event_espresso"
+				),
+				get_class($this),
+				$this_model_name,
+				$other_model_name,
+				$this->_blocking_delete
+			));
+		}
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_this_model()
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_other_model()
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string $timezone timezone to set.
+	 */
+	public function set_timezone($timezone)
+	{
+		if ($timezone !== null) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param        $other_table
+	 * @param        $other_table_alias
+	 * @param        $other_table_column
+	 * @param        $this_table_alias
+	 * @param        $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		$other_table,
+		$other_table_alias,
+		$other_table_column,
+		$this_table_alias,
+		$this_table_join_column,
+		$extra_join_sql = ''
+	) {
+		return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
+	 * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1'
+			);
+		}
+		$query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
+		$query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
+															 . "."
+															 . $this->get_this_model()->get_primary_key_field()->get_name();
+		$model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param string $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_all_related($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
+	 * @throws EE_Error
+	 * @return int
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(sprintf(
+				__(
+					"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+					"event_espresso"
+				),
+				$this->get_other_model()->get_this_model_name(),
+				$this->get_this_model()->get_this_model_name()
+			));
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement($model_relation_chain);
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		$extra_join_model_fields_n_values = array()
+	);
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $where_query
+	 * @return bool
+	 */
+	abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function remove_relations($this_obj_or_id, $where_query_param = array())
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
+		$objs_removed   = array();
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist()
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 */
+	public function get_deletion_error_message()
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                __(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(1),
-                $this->get_other_model()->item_name(1),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return true;
-    }
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'relation' => true,
-            'relation_type' => get_class($this),
-            'readonly' => $this->getSchemaReadonly()
-        );
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = array(
-                'type' => 'object'
-            );
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(1),
+				$this->get_other_model()->item_name(1),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return true;
+	}
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'relation' => true,
+			'relation_type' => get_class($this),
+			'readonly' => $this->getSchemaReadonly()
+		);
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = array(
+				'type' => 'object'
+			);
+		}
+
+		return $schema;
+	}
 }