eventespresso / event-espresso-core

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

Indentation +598 added lines, -602 removed lines

@@ -53,10 +53,6 @@ 
 ENGINE=InnoDB
 AUTO_INCREMENT=3
 ;
-
-
-
-
  * 4.1 Attendee tables and fields:
  * $this->_tables = array(
             'Attendee_CPT'=> new EE_Primary_Table('posts', 'ID'),
@@ -186,634 +182,634 @@ 
  */
 class EE_DMS_4_1_0_attendees extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_attendee_cpt_table;
-    private $_new_attendee_meta_table;
-    private $_new_reg_table;
-    private $_new_transaction_table;
-    private $_new_payment_table;
-    private $_new_line_table;
-    private $_old_mer_table;
-    private $_new_ticket_table;
-    private $_new_ticket_datetime_table;
-    private $_new_datetime_table;
-    private $_new_datetime_ticket_table;
-    private $_new_price_table;
-    private $_new_ticket_price_table;
-    /**
-     * Rememebrs whether or not the mer table exists
-     * @var boolean
-     */
-    private $_mer_tables_exist = null;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Attendees", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        $this->_extra_where_sql = 'AS att
+	private $_new_attendee_cpt_table;
+	private $_new_attendee_meta_table;
+	private $_new_reg_table;
+	private $_new_transaction_table;
+	private $_new_payment_table;
+	private $_new_line_table;
+	private $_old_mer_table;
+	private $_new_ticket_table;
+	private $_new_ticket_datetime_table;
+	private $_new_datetime_table;
+	private $_new_datetime_ticket_table;
+	private $_new_price_table;
+	private $_new_ticket_price_table;
+	/**
+	 * Rememebrs whether or not the mer table exists
+	 * @var boolean
+	 */
+	private $_mer_tables_exist = null;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Attendees", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$this->_extra_where_sql = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
-        $this->_new_attendee_cpt_table = $wpdb->posts;
-        $this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
-        $this->_new_reg_table = $wpdb->prefix."esp_registration";
-        $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
-        $this->_new_payment_table = $wpdb->prefix."esp_payment";
-        $this->_new_line_table = $wpdb->prefix."esp_line_item";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_datetime_table = $wpdb->prefix."esp_datetime";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        parent::__construct();
-    }
+		$this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
+		$this->_new_attendee_cpt_table = $wpdb->posts;
+		$this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
+		$this->_new_reg_table = $wpdb->prefix."esp_registration";
+		$this->_new_transaction_table = $wpdb->prefix."esp_transaction";
+		$this->_new_payment_table = $wpdb->prefix."esp_payment";
+		$this->_new_line_table = $wpdb->prefix."esp_line_item";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_datetime_table = $wpdb->prefix."esp_datetime";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		parent::__construct();
+	}
 
-    protected function _migrate_old_row($old_row)
-    {
-        // first check if there's already a new attendee with similar characteristics
-        $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
-            $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
-                // if we couldnt even make an attendee, abandon all hope
-                return false;
-            }
-            $new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
-            if ($new_att_meta_id) {
-                $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
-            }
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
+	protected function _migrate_old_row($old_row)
+	{
+		// first check if there's already a new attendee with similar characteristics
+		$new_att_id = $this->_find_attendee_cpt_matching($old_row);
+		if (! $new_att_id) {
+			$new_att_id = $this->_insert_new_attendee_cpt($old_row);
+			if (! $new_att_id) {
+				// if we couldnt even make an attendee, abandon all hope
+				return false;
+			}
+			$new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
+			if ($new_att_meta_id) {
+				$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
+			}
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
-        $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
-            // if we couldnt make the transaction, also abandon all hope
-            return false;
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
-        $pay_id = $this->_insert_new_payment($old_row, $txn_id);
-        if ($pay_id) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
-        }
+		$txn_id = $this->_insert_new_transaction($old_row);
+		if (! $txn_id) {
+			// if we couldnt make the transaction, also abandon all hope
+			return false;
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
+		$pay_id = $this->_insert_new_payment($old_row, $txn_id);
+		if ($pay_id) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
+		}
 
 
-        // even if there was no payment, we can go ahead with adding the reg
-        $new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
-        if ($new_regs) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
-        }
-    }
-    /**
-     * Checks if there's already an attendee CPT in the db that has the same
-     * first and last name, and email. If so, returns its ID as an int.
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @return int
-     */
-    private function _find_attendee_cpt_matching($old_attendee)
-    {
-        global $wpdb;
-        $existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
-        return intval($existing_attendee_id);
-    }
-    private function _insert_new_attendee_cpt($old_attendee)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
-            'post_status'=>'publish'// status
-        );
-        $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
-        );
-        $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		// even if there was no payment, we can go ahead with adding the reg
+		$new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
+		if ($new_regs) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
+		}
+	}
+	/**
+	 * Checks if there's already an attendee CPT in the db that has the same
+	 * first and last name, and email. If so, returns its ID as an int.
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @return int
+	 */
+	private function _find_attendee_cpt_matching($old_attendee)
+	{
+		global $wpdb;
+		$existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
+		return intval($existing_attendee_id);
+	}
+	private function _insert_new_attendee_cpt($old_attendee)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
+			'post_content'=>'',// ATT_bio
+			'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
+			'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
+			'post_excerpt'=>'',// ATT_short_bio
+			'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
+			'post_author'=>0,// ATT_author
+			'post_parent'=>0,// ATT_parent
+			'post_type'=>'espresso_attendees',// post_type
+			'post_status'=>'publish'// status
+		);
+		$datatypes = array(
+			'%s',// ATT_full_name
+			'%s',// ATT_bio
+			'%s',// ATT_slug
+			'%s',// ATT_created
+			'%s',// ATT_short_bio
+			'%s',// ATT_modified
+			'%d',// ATT_author
+			'%d',// ATT_parent
+			'%s',// post_type
+			'%s',// status
+		);
+		$success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
-    {
-        global $wpdb;
-        // get the state and country ids from the old row
-        try {
-            $new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
-            $new_country_iso = $new_country['CNT_ISO'];
-        } catch (EE_Error $exception) {
-            $new_country_iso = $this->get_migration_script()->get_default_country_iso();
-        }
-        try {
-            $new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
-            $new_state_id = $new_state['STA_ID'];
-        } catch (EE_Error $exception) {
-            $new_state_id = 0;
-        }
-        $cols_n_values = array(
-            'ATT_ID'=>$new_attendee_cpt_id,
-            'ATT_fname'=>stripslashes($old_attendee['fname']),
-            'ATT_lname'=>stripslashes($old_attendee['lname']),
-            'ATT_address'=>stripslashes($old_attendee['address']),
-            'ATT_address2'=>stripslashes($old_attendee['address2']),
-            'ATT_city'=>stripslashes($old_attendee['city']),
-            'STA_ID'=>$new_state_id,
-            'CNT_ISO'=>$new_country_iso,
-            'ATT_zip'=>stripslashes($old_attendee['zip']),
-            'ATT_email'=>stripslashes($old_attendee['email']),
-            'ATT_phone'=>stripslashes($old_attendee['phone']),
-        );
-        $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
-        );
-        $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
+	{
+		global $wpdb;
+		// get the state and country ids from the old row
+		try {
+			$new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
+			$new_country_iso = $new_country['CNT_ISO'];
+		} catch (EE_Error $exception) {
+			$new_country_iso = $this->get_migration_script()->get_default_country_iso();
+		}
+		try {
+			$new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
+			$new_state_id = $new_state['STA_ID'];
+		} catch (EE_Error $exception) {
+			$new_state_id = 0;
+		}
+		$cols_n_values = array(
+			'ATT_ID'=>$new_attendee_cpt_id,
+			'ATT_fname'=>stripslashes($old_attendee['fname']),
+			'ATT_lname'=>stripslashes($old_attendee['lname']),
+			'ATT_address'=>stripslashes($old_attendee['address']),
+			'ATT_address2'=>stripslashes($old_attendee['address2']),
+			'ATT_city'=>stripslashes($old_attendee['city']),
+			'STA_ID'=>$new_state_id,
+			'CNT_ISO'=>$new_country_iso,
+			'ATT_zip'=>stripslashes($old_attendee['zip']),
+			'ATT_email'=>stripslashes($old_attendee['email']),
+			'ATT_phone'=>stripslashes($old_attendee['phone']),
+		);
+		$datatypes = array(
+			'%d',// ATT_ID
+			'%s',// ATT_fname
+			'%s',// ATT_lname
+			'%s',// ATT_address
+			'%s',// ATT_address2
+			'%s',// ATT_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// ATT_zip
+			'%s',// ATT_email
+			'%s',// ATT_phone
+		);
+		$success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Note: we don't necessarily create a new transaction for each attendee row.
-     * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
-     * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
-     * @global type $wpdb
-     * @param type $old_attendee
-     * @return int new transaction id
-     */
-    private function _insert_new_transaction($old_attendee)
-    {
-        global $wpdb;
+	/**
+	 * Note: we don't necessarily create a new transaction for each attendee row.
+	 * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
+	 * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
+	 * @global type $wpdb
+	 * @param type $old_attendee
+	 * @return int new transaction id
+	 */
+	private function _insert_new_transaction($old_attendee)
+	{
+		global $wpdb;
 
-        // first: let's check for an existing transaction for this old attendee
-        if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
-        } else { // non-primary attendee, so find its primary attendee's transaction
-            $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
-                $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
-                $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
-            }
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
-                $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
-                $txn_id = 0;
-            }
-        }
-        // if there isn't yet a transaction row for this, create one
-        // (so even if it was a non-primary attendee with no EE3 primary attendee,
-        // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
-            // maps 3.1 payment stati onto 4.1 transaction stati
-            $txn_status_mapping = array(
-                'Completed'=>'TCM',
-                'Pending'=>'TIN',
-                'Payment Declined'=>'TIN',
-                'Incomplete'=>'TIN',
-                'Not Completed'=>'TIN',
-                'Cancelled'=>'TIN',
-                'Declined'=>'TIN'
-            );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
-            $cols_n_values = array(
-                'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'TXN_total'=>floatval($old_attendee['total_cost']),
-                'TXN_paid'=>floatval($old_attendee['amount_pd']),
-                'STS_ID'=>$STS_ID,
-                'TXN_hash_salt'=>$old_attendee['hashSalt']
-            );
-            $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
-            );
-            $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $txn_id = $wpdb->insert_id;
-        }
+		// first: let's check for an existing transaction for this old attendee
+		if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
+		} else { // non-primary attendee, so find its primary attendee's transaction
+			$primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
+			if (! $primary_attendee_old_id) {
+				$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
+				$primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
+			}
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
+			if (! $txn_id) {
+				$this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
+				$txn_id = 0;
+			}
+		}
+		// if there isn't yet a transaction row for this, create one
+		// (so even if it was a non-primary attendee with no EE3 primary attendee,
+		// it ought to have SOME transaction, so we'll make one)
+		if (! $txn_id) {
+			// maps 3.1 payment stati onto 4.1 transaction stati
+			$txn_status_mapping = array(
+				'Completed'=>'TCM',
+				'Pending'=>'TIN',
+				'Payment Declined'=>'TIN',
+				'Incomplete'=>'TIN',
+				'Not Completed'=>'TIN',
+				'Cancelled'=>'TIN',
+				'Declined'=>'TIN'
+			);
+			$STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+			$cols_n_values = array(
+				'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'TXN_total'=>floatval($old_attendee['total_cost']),
+				'TXN_paid'=>floatval($old_attendee['amount_pd']),
+				'STS_ID'=>$STS_ID,
+				'TXN_hash_salt'=>$old_attendee['hashSalt']
+			);
+			$datatypes = array(
+				'%s',// TXN_timestamp
+				'%f',// TXN_total
+				'%f',// TXN_paid
+				'%s',// STS_ID
+				'%s',// TXN_hash_salt
+			);
+			$success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$txn_id = $wpdb->insert_id;
+		}
 
-        return $txn_id;
-    }
-    /**
-     * Detects if the MER tables exist
-     * @global type $wpdb
-     * @return boolean
-     */
-    private function _mer_tables_exist()
-    {
-        if ($this->_mer_tables_exist === null) {
-            global $wpdb;
+		return $txn_id;
+	}
+	/**
+	 * Detects if the MER tables exist
+	 * @global type $wpdb
+	 * @return boolean
+	 */
+	private function _mer_tables_exist()
+	{
+		if ($this->_mer_tables_exist === null) {
+			global $wpdb;
 
-            if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
-                $this->_mer_tables_exist = false;
-            } else {
-                $this->_mer_tables_exist = true;
-            }
-        }
-        return $this->_mer_tables_exist;
-    }
+			if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
+				$this->_mer_tables_exist = false;
+			} else {
+				$this->_mer_tables_exist = true;
+			}
+		}
+		return $this->_mer_tables_exist;
+	}
 
-    /**
-     * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
-     * whether the event required pre-approval or not,a dn the 4.1 payment status.
-     * @global type $wpdb
-     * @param type $old_attendee_row
-     * @return string
-     */
-    private function _get_reg_status_for_old_payment_status($old_attendee_row)
-    {
-        // need event default reg status and if pre_approval was required
-        global $wpdb;
-        $event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
-        return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
-            $old_attendee_row['payment_status'],
-            intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
-        );
-    }
-    /**
-     * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
-     * and returns an array of their IDs
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @param int $new_attendee_id
-     * @param int $new_txn_id
-     * @return array of new registratio ids
-     */
-    private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
-    {
-        global $wpdb;
+	/**
+	 * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
+	 * whether the event required pre-approval or not,a dn the 4.1 payment status.
+	 * @global type $wpdb
+	 * @param type $old_attendee_row
+	 * @return string
+	 */
+	private function _get_reg_status_for_old_payment_status($old_attendee_row)
+	{
+		// need event default reg status and if pre_approval was required
+		global $wpdb;
+		$event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
+		return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
+			$old_attendee_row['payment_status'],
+			intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
+		);
+	}
+	/**
+	 * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
+	 * and returns an array of their IDs
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @param int $new_attendee_id
+	 * @param int $new_txn_id
+	 * @return array of new registratio ids
+	 */
+	private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
+	{
+		global $wpdb;
 
-        $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
-        }
+		$STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
+		}
 
-        $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
-            $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
-            $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
-        }
-        $regs_on_this_row = intval($old_attendee['quantity']);
-        $new_regs = array();
-        // 4 cases we need to account for:
-        // 1 old attendee_details row with a quantity of X (no mer)
-        // Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
-        // Y old attendee_details rows with a quantity of x (because of mer)
-        // Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
-        for ($count = 1; $count <= $regs_on_this_row; $count++) {
-            // sum regs on older rows
-            $regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
-            $cols_n_values = array(
-                'EVT_ID'=>$new_event_id,
-                'ATT_ID'=>$new_attendee_id,
-                'TXN_ID'=>$new_txn_id,
-                'TKT_ID'=>$ticket_id,
-                'STS_ID'=>$STS_ID,
-                'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'REG_final_price'=>$old_attendee['final_price'],
-                'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
-                'REG_code'=>sanitize_key($old_attendee['registration_id']),
-                'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
-                'REG_count'=>$regs_on_this_event_and_txn + $count,
-                'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
-                'REG_att_is_going'=>true,
-                'REG_deleted'=>false
-            );
-            $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
-            );
-            $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $cols_n_values['REG_ID'] = $wpdb->insert_id;
-            $new_regs[] = $wpdb->insert_id;
-        }
-        $this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
-        return $new_regs;
-    }
+		$ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
+		if (! $ticket_id) {
+			$ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
+			$this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
+		}
+		$regs_on_this_row = intval($old_attendee['quantity']);
+		$new_regs = array();
+		// 4 cases we need to account for:
+		// 1 old attendee_details row with a quantity of X (no mer)
+		// Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
+		// Y old attendee_details rows with a quantity of x (because of mer)
+		// Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
+		for ($count = 1; $count <= $regs_on_this_row; $count++) {
+			// sum regs on older rows
+			$regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
+			$cols_n_values = array(
+				'EVT_ID'=>$new_event_id,
+				'ATT_ID'=>$new_attendee_id,
+				'TXN_ID'=>$new_txn_id,
+				'TKT_ID'=>$ticket_id,
+				'STS_ID'=>$STS_ID,
+				'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'REG_final_price'=>$old_attendee['final_price'],
+				'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
+				'REG_code'=>sanitize_key($old_attendee['registration_id']),
+				'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
+				'REG_count'=>$regs_on_this_event_and_txn + $count,
+				'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
+				'REG_att_is_going'=>true,
+				'REG_deleted'=>false
+			);
+			$datatypes = array(
+				'%d',// EVT_ID
+				'%d',// ATT_ID
+				'%d',// TXN_ID
+				'%d',// TKT_ID
+				'%s',// STS_ID
+				'%s',// REG_date
+				'%f',// REG_final_price
+				'%s',// REG_session
+				'%s',// REG_code
+				'%s',// REG_url_link
+				'%d',// REG_count
+				'%d',// REG_group_size
+				'%d',// REG_att_is_going
+				'%d',// REG_deleted
+			);
+			$success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$cols_n_values['REG_ID'] = $wpdb->insert_id;
+			$new_regs[] = $wpdb->insert_id;
+		}
+		$this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
+		return $new_regs;
+	}
 
-    /**
-     * Increments the sold values on the ticket and its related datetimes by the amount sold,
-     * which should be done directly after adding the rows. Yes this means we're constantly incrementing
-     * the sold amounts as we go, and is less efficient than a single big query,
-     * but its safer because we KNOW these regs have been added, rather than inferring
-     * that they WILL be added (because the attendees stage runs nearly last during
-     * the migration script)
-     * @param type $new_ticket_id
-     * @param type $sold
-     * @param type $STS_ID
-     * @return boolean whether they were successfully updated or not
-     */
-    protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
-    {
-        if ($STS_ID != 'RAP') {
-            return true;
-        }
-        global $wpdb;
-        $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
-        if ($success) {
-            // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+	/**
+	 * Increments the sold values on the ticket and its related datetimes by the amount sold,
+	 * which should be done directly after adding the rows. Yes this means we're constantly incrementing
+	 * the sold amounts as we go, and is less efficient than a single big query,
+	 * but its safer because we KNOW these regs have been added, rather than inferring
+	 * that they WILL be added (because the attendees stage runs nearly last during
+	 * the migration script)
+	 * @param type $new_ticket_id
+	 * @param type $sold
+	 * @param type $STS_ID
+	 * @return boolean whether they were successfully updated or not
+	 */
+	protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
+	{
+		if ($STS_ID != 'RAP') {
+			return true;
+		}
+		global $wpdb;
+		$success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
+		if ($success) {
+			// get the ticket's datetimes, and increment them too
+			$success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
-                $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-            }
-        } else {
-            $this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-        }
-        return true;
-    }
-    /**
-     * Makes a best guess at which ticket is the one the attendee purchased.
-     * Obviously, the old attendee's event_id narrows it down quite a bit;
-     * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
-     * however, if we don't find an exact match, see if any of those conditions match;
-     * and lastly if none of that works, just use the first ticket for the event we find
-     * @param array $old_attendee
-     */
-    private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $tickets_table = $this->_new_ticket_table;
-        $datetime_tickets_table = $this->_new_ticket_datetime_table;
-        $datetime_table = $this->_new_datetime_table;
+			if (! $success_update_dateimtes) {
+				$this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+			}
+		} else {
+			$this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+		}
+		return true;
+	}
+	/**
+	 * Makes a best guess at which ticket is the one the attendee purchased.
+	 * Obviously, the old attendee's event_id narrows it down quite a bit;
+	 * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
+	 * however, if we don't find an exact match, see if any of those conditions match;
+	 * and lastly if none of that works, just use the first ticket for the event we find
+	 * @param array $old_attendee
+	 */
+	private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$tickets_table = $this->_new_ticket_table;
+		$datetime_tickets_table = $this->_new_ticket_datetime_table;
+		$datetime_table = $this->_new_datetime_table;
 
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        );
-        $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions = array(
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
+			$wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		);
+		$select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
 			$datetime_table ON $datetime_tickets_table.DTT_ID = $datetime_table.DTT_ID";
-        // start running queries, widening search each time by removing a condition
-        do {
-            $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
-            $ticket_id_found = $wpdb->get_var($full_query);
-            array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
-        return $ticket_id_found;
-    }
+		// start running queries, widening search each time by removing a condition
+		do {
+			$full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
+			$ticket_id_found = $wpdb->get_var($full_query);
+			array_shift($conditions);
+		} while (! $ticket_id_found && $conditions);
+		return $ticket_id_found;
+	}
 
-    /**
-     * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
-     * and it also tries to find a datetime that works, and a inserts a price, and associates
-     * the new ticket to that datetime and price.
-     * @return int ticket id
-     */
-    private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+	/**
+	 * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
+	 * and it also tries to find a datetime that works, and a inserts a price, and associates
+	 * the new ticket to that datetime and price.
+	 * @return int ticket id
+	 */
+	private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
 
 
-        // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
-            $old_att_end_date = $old_attendee['start_date'];
-            $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-            $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
-            $wpdb->insert(
-                $this->_new_datetime_table,
-                array(
-                        'EVT_ID' => $new_event_id,
-                        'DTT_EVT_start' => $old_att_start_datetime,
-                        'DTT_EVT_end' => $old_att_end_datetime,
-                        'DTT_deleted' => true
-                    ),
-                array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
-                    )
-            );
-            $datetime_id = $wpdb->insert_id;
-        }
+		// insert new datetime unless we find one
+		$datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+		if (! $datetime_id) {
+			$old_att_end_date = $old_attendee['start_date'];
+			$old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+			$old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
+			$wpdb->insert(
+				$this->_new_datetime_table,
+				array(
+						'EVT_ID' => $new_event_id,
+						'DTT_EVT_start' => $old_att_start_datetime,
+						'DTT_EVT_end' => $old_att_end_datetime,
+						'DTT_deleted' => true
+					),
+				array(
+						'%d',// EVT_ID
+						'%s',// DTT_EVT_start
+						'%s',// DTT_EVT_end
+						'%d',// DTT_deleted
+					)
+			);
+			$datetime_id = $wpdb->insert_id;
+		}
 
-        // insert new ticket
-        $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
-            array(
-                    'TKT_name' => $old_att_price_option,
-                    'TKT_qty' => -1,
-                    'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
-                    'TKT_end_date' => $old_att_end_datetime,
+		// insert new ticket
+		$success = $wpdb->insert(
+			$wpdb->prefix . 'esp_ticket',
+			array(
+					'TKT_name' => $old_att_price_option,
+					'TKT_qty' => -1,
+					'TKT_price' => $old_att_price,
+					'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+					'TKT_end_date' => $old_att_end_datetime,
 
-                ),
-            array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
-                )
-        );
-        $ticket_id = $wpdb->insert_id;
-        // associate the ticket with the datetime we found earlier
-        $wpdb->insert(
-            $this->_new_datetime_ticket_table,
-            array(
-                    'DTT_ID' => $datetime_id,
-                    'TKT_ID' => $ticket_id
-                ),
-            array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
-                )
-        );
-        // insert new price
-        $wpdb->insert(
-            $this->_new_price_table,
-            array(
-                    'PRC_amount' => $old_att_price,
-                    'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
-                    'PRC_name' => $old_att_price_option,
-                    'PRC_deleted' => true
-                ),
-            array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
-                )
-        );
-        $price_id = $wpdb->insert_id;
-        // associate the price to the ticket
-        $wpdb->insert(
-            $this->_new_ticket_price_table,
-            array(
-                    'TKT_ID' => $ticket_id,
-                    'PRC_ID' => $price_id
-                ),
-            array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
-                )
-        );
-        return $ticket_id;
-    }
-    /**
-     * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
-     * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
-     * @global type $wpdb
-     * @param array $old_attendee_row
-     * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
-     * @return int
-     */
-    private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
-    {
-        global $wpdb;
-        $count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
-        $count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
+				),
+			array(
+					'%s',// name
+					'%d',// qty
+					'%d',// price
+					'%s',// start_date
+					'%s',// end_date
+				)
+		);
+		$ticket_id = $wpdb->insert_id;
+		// associate the ticket with the datetime we found earlier
+		$wpdb->insert(
+			$this->_new_datetime_ticket_table,
+			array(
+					'DTT_ID' => $datetime_id,
+					'TKT_ID' => $ticket_id
+				),
+			array(
+					'%d',// DTT_ID
+					'%d',// TKT_ID
+				)
+		);
+		// insert new price
+		$wpdb->insert(
+			$this->_new_price_table,
+			array(
+					'PRC_amount' => $old_att_price,
+					'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
+					'PRC_name' => $old_att_price_option,
+					'PRC_deleted' => true
+				),
+			array(
+					'%d',// PRC_amount
+					'%d',// PRT_ID
+					'%s',// PRC_name
+					'%d',// PRC_deleted
+				)
+		);
+		$price_id = $wpdb->insert_id;
+		// associate the price to the ticket
+		$wpdb->insert(
+			$this->_new_ticket_price_table,
+			array(
+					'TKT_ID' => $ticket_id,
+					'PRC_ID' => $price_id
+				),
+			array(
+					'%d',// TKT_ID
+					'%d',// PRC_ID
+				)
+		);
+		return $ticket_id;
+	}
+	/**
+	 * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
+	 * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
+	 * @global type $wpdb
+	 * @param array $old_attendee_row
+	 * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
+	 * @return int
+	 */
+	private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
+	{
+		global $wpdb;
+		$count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
+		$count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
 
-        if ($this->_mer_tables_exist()) {
-            // if MER exists, then its a little tricky.
-            // when users registered by adding items to the cart, and it was a
-            // group registration requiring additional attendee INFO, then the attendee rows
-            // DO NOT have the same registration_id (although they probably should have)
-            // they are related just like MER attendee rows are related, through the MER group table
-            // BUT we want to count all the MER attendee rows for the same registration
-            $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
+		if ($this->_mer_tables_exist()) {
+			// if MER exists, then its a little tricky.
+			// when users registered by adding items to the cart, and it was a
+			// group registration requiring additional attendee INFO, then the attendee rows
+			// DO NOT have the same registration_id (although they probably should have)
+			// they are related just like MER attendee rows are related, through the MER group table
+			// BUT we want to count all the MER attendee rows for the same registration
+			$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
 
-            $count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
-            $count = max($count_using_mer_table, $count);
-        }
-        return $count;
-    }
-    private function _insert_new_payment($old_attendee, $new_txn_id)
-    {
-        global $wpdb;
-        // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
-        // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
-        if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
-            $pay_status_mapping = array(
-                'Completed'=>'PAP',
-                'Payment Declined'=>'PDC',
-                'Cancelled'=>'PCN',
-                'Declined'=>'PDC'
-            );
-            $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
-            $cols_n_values = array(
-                'TXN_ID'=>$new_txn_id,
-                'STS_ID'=>$STS_ID,
-                'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'PAY_method'=>'CART',
-                'PAY_amount'=>$old_attendee['amount_pd'],
-                'PAY_gateway'=>$old_attendee['txn_type'],
-                'PAY_gateway_response'=>'',
-                'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
-                'PAY_via_admin'=>$by_admin,
-                'PAY_details'=>$old_attendee['transaction_details']
+			$count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
+			$count = max($count_using_mer_table, $count);
+		}
+		return $count;
+	}
+	private function _insert_new_payment($old_attendee, $new_txn_id)
+	{
+		global $wpdb;
+		// only add a payment for primary attendees
+		$old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+		// if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
+		if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
+			$pay_status_mapping = array(
+				'Completed'=>'PAP',
+				'Payment Declined'=>'PDC',
+				'Cancelled'=>'PCN',
+				'Declined'=>'PDC'
+			);
+			$by_admin = $old_attendee['payment'] == 'Admin';
+			$STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+			$cols_n_values = array(
+				'TXN_ID'=>$new_txn_id,
+				'STS_ID'=>$STS_ID,
+				'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'PAY_method'=>'CART',
+				'PAY_amount'=>$old_attendee['amount_pd'],
+				'PAY_gateway'=>$old_attendee['txn_type'],
+				'PAY_gateway_response'=>'',
+				'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
+				'PAY_via_admin'=>$by_admin,
+				'PAY_details'=>$old_attendee['transaction_details']
 
-            );
-            $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
-            );
-            $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $new_id = $wpdb->insert_id;
-            return $new_id;
-        } else {
-            return 0;
-        }
-    }
+			);
+			$datatypes = array(
+				'%d',// TXN_Id
+				'%s',// STS_ID
+				'%s',// PAY_timestamp
+				'%s',// PAY_method
+				'%f',// PAY_amount
+				'%s',// PAY_gateway
+				'%s',// PAY_gateway_response
+				'%s',// PAY_txn_id_chq_nmbr
+				'%d',// PAY_via_admin
+				'%s',// PAY_details
+			);
+			$success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$new_id = $wpdb->insert_id;
+			return $new_id;
+		} else {
+			return 0;
+		}
+	}
 
-    /**
-     * If MER is active, if you want ot fin dthe other registrations on that attendee row
-     * @global type $wpdb
-     * @param type $old_registration_id
-     * @return array
-     */
-    private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
-    {
-        if (! $this->_mer_tables_exist()) {
-            return false;
-        }
-        global $wpdb;
-        $old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
-        return $old_att_for_primary_reg;
-    }
+	/**
+	 * If MER is active, if you want ot fin dthe other registrations on that attendee row
+	 * @global type $wpdb
+	 * @param type $old_registration_id
+	 * @return array
+	 */
+	private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
+	{
+		if (! $this->_mer_tables_exist()) {
+			return false;
+		}
+		global $wpdb;
+		$old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
+		return $old_att_for_primary_reg;
+	}
 }

Spacing +105 added lines, -105 removed lines

@@ -210,7 +210,7 @@ 
         $this->_pretty_name = __("Attendees", "event_espresso");
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->_extra_where_sql = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
         $this->_new_attendee_cpt_table = $wpdb->posts;
@@ -232,9 +232,9 @@ 
     {
         // first check if there's already a new attendee with similar characteristics
         $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
+        if ( ! $new_att_id) {
             $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
+            if ( ! $new_att_id) {
                 // if we couldnt even make an attendee, abandon all hope
                 return false;
             }
@@ -246,7 +246,7 @@ 
         $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
         $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // if we couldnt make the transaction, also abandon all hope
             return false;
         }
@@ -280,31 +280,31 @@ 
     {
         global $wpdb;
         $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
+            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']), // ATT_full_name
+            'post_content'=>'', // ATT_bio
+            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']), // ATT_slug
+            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_created
+            'post_excerpt'=>'', // ATT_short_bio
+            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_modified
+            'post_author'=>0, // ATT_author
+            'post_parent'=>0, // ATT_parent
+            'post_type'=>'espresso_attendees', // post_type
             'post_status'=>'publish'// status
         );
         $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
+            '%s', // ATT_full_name
+            '%s', // ATT_bio
+            '%s', // ATT_slug
+            '%s', // ATT_created
+            '%s', // ATT_short_bio
+            '%s', // ATT_modified
+            '%d', // ATT_author
+            '%d', // ATT_parent
+            '%s', // post_type
+            '%s', // status
         );
         $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -342,20 +342,20 @@ 
             'ATT_phone'=>stripslashes($old_attendee['phone']),
         );
         $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
+            '%d', // ATT_ID
+            '%s', // ATT_fname
+            '%s', // ATT_lname
+            '%s', // ATT_address
+            '%s', // ATT_address2
+            '%s', // ATT_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // ATT_zip
+            '%s', // ATT_email
+            '%s', // ATT_phone
         );
         $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -380,12 +380,12 @@ 
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
         } else { // non-primary attendee, so find its primary attendee's transaction
             $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
+            if ( ! $primary_attendee_old_id) {
                 $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
                 $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
             }
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
                 $txn_id = 0;
             }
@@ -393,7 +393,7 @@ 
         // if there isn't yet a transaction row for this, create one
         // (so even if it was a non-primary attendee with no EE3 primary attendee,
         // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // maps 3.1 payment stati onto 4.1 transaction stati
             $txn_status_mapping = array(
                 'Completed'=>'TCM',
@@ -404,7 +404,7 @@ 
                 'Cancelled'=>'TIN',
                 'Declined'=>'TIN'
             );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+            $STS_ID = isset($txn_status_mapping[$old_attendee['payment_status']]) ? $txn_status_mapping[$old_attendee['payment_status']] : 'TIN';
             $cols_n_values = array(
                 'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
                 'TXN_total'=>floatval($old_attendee['total_cost']),
@@ -413,14 +413,14 @@ 
                 'TXN_hash_salt'=>$old_attendee['hashSalt']
             );
             $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
+                '%s', // TXN_timestamp
+                '%f', // TXN_total
+                '%f', // TXN_paid
+                '%s', // STS_ID
+                '%s', // TXN_hash_salt
             );
             $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -480,12 +480,12 @@ 
 
         $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
         }
 
         $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
+        if ( ! $ticket_id) {
             $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
             $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
         }
@@ -516,23 +516,23 @@ 
                 'REG_deleted'=>false
             );
             $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
+                '%d', // EVT_ID
+                '%d', // ATT_ID
+                '%d', // TXN_ID
+                '%d', // TKT_ID
+                '%s', // STS_ID
+                '%s', // REG_date
+                '%f', // REG_final_price
+                '%s', // REG_session
+                '%s', // REG_code
+                '%s', // REG_url_link
+                '%d', // REG_count
+                '%d', // REG_group_size
+                '%d', // REG_att_is_going
+                '%d', // REG_deleted
             );
             $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -564,11 +564,11 @@ 
         $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
         if ($success) {
             // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+            $success_update_dateimtes = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
+            if ( ! $success_update_dateimtes) {
                 $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
             }
         } else {
@@ -600,10 +600,10 @@ 
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price), // prices match?
+            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option), // names match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         );
         $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
@@ -613,7 +613,7 @@ 
             $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $ticket_id_found = $wpdb->get_var($full_query);
             array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
+        }while ( ! $ticket_id_found && $conditions);
         return $ticket_id_found;
     }
 
@@ -635,8 +635,8 @@ 
 
 
         // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
+        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM ".$this->_new_datetime_table." WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+        if ( ! $datetime_id) {
             $old_att_end_date = $old_attendee['start_date'];
             $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
             $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
@@ -649,10 +649,10 @@ 
                         'DTT_deleted' => true
                     ),
                 array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
+                        '%d', // EVT_ID
+                        '%s', // DTT_EVT_start
+                        '%s', // DTT_EVT_end
+                        '%d', // DTT_deleted
                     )
             );
             $datetime_id = $wpdb->insert_id;
@@ -660,21 +660,21 @@ 
 
         // insert new ticket
         $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
+            $wpdb->prefix.'esp_ticket',
             array(
                     'TKT_name' => $old_att_price_option,
                     'TKT_qty' => -1,
                     'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+                    'TKT_start_date' => $old_att_start_datetime, // we really have no clue what the time should be, but at least it was available when they attended
                     'TKT_end_date' => $old_att_end_datetime,
 
                 ),
             array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
+                    '%s', // name
+                    '%d', // qty
+                    '%d', // price
+                    '%s', // start_date
+                    '%s', // end_date
                 )
         );
         $ticket_id = $wpdb->insert_id;
@@ -686,8 +686,8 @@ 
                     'TKT_ID' => $ticket_id
                 ),
             array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
+                    '%d', // DTT_ID
+                    '%d', // TKT_ID
                 )
         );
         // insert new price
@@ -700,10 +700,10 @@ 
                     'PRC_deleted' => true
                 ),
             array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
+                    '%d', // PRC_amount
+                    '%d', // PRT_ID
+                    '%s', // PRC_name
+                    '%d', // PRC_deleted
                 )
         );
         $price_id = $wpdb->insert_id;
@@ -715,8 +715,8 @@ 
                     'PRC_ID' => $price_id
                 ),
             array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
+                    '%d', // TKT_ID
+                    '%d', // PRC_ID
                 )
         );
         return $ticket_id;
@@ -753,7 +753,7 @@ 
     {
         global $wpdb;
         // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+        $old_pay_stati_indicating_no_payment = array('Pending', 'Incomplete', 'Not Completed');
         // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
         if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
             $pay_status_mapping = array(
@@ -763,7 +763,7 @@ 
                 'Declined'=>'PDC'
             );
             $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+            $STS_ID = isset($pay_status_mapping[$old_attendee['payment_status']]) ? $pay_status_mapping[$old_attendee['payment_status']] : 'PFL'; // IE, if we don't recognize the status, assume payment failed
             $cols_n_values = array(
                 'TXN_ID'=>$new_txn_id,
                 'STS_ID'=>$STS_ID,
@@ -778,19 +778,19 @@ 
 
             );
             $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
+                '%d', // TXN_Id
+                '%s', // STS_ID
+                '%s', // PAY_timestamp
+                '%s', // PAY_method
+                '%f', // PAY_amount
+                '%s', // PAY_gateway
+                '%s', // PAY_gateway_response
+                '%s', // PAY_txn_id_chq_nmbr
+                '%d', // PAY_via_admin
+                '%s', // PAY_details
             );
             $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -809,7 +809,7 @@ 
      */
     private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
     {
-        if (! $this->_mer_tables_exist()) {
+        if ( ! $this->_mer_tables_exist()) {
             return false;
         }
         global $wpdb;

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

Indentation +87 added lines, -90 removed lines

@@ -25,105 +25,102 @@
 
             )
         );
-
-
-
  *
  */
 class EE_DMS_4_1_0_event_venue extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_new_table;
-    public function _migration_step($num_items = 50)
-    {
+	private $_old_table;
+	private $_new_table;
+	public function _migration_step($num_items = 50)
+	{
         
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results(
-            $wpdb->prepare(
-                "SELECT * FROM $this->_old_table AS ev 
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT * FROM $this->_old_table AS ev 
                     INNER JOIN " . $wpdb->prefix . "events_detail AS e ON ev.event_id=e.id
                     WHERE e.event_status!='D' LIMIT %d,%d",
-                $start_at_record,
-                $num_items
-            ),
-            ARRAY_A
-        );
-        $items_actually_migrated = 0;
-        foreach ($rows as $event_venue_rel) {
-            $this->_insert_new_event_to_venue_rel($event_venue_rel);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var(
-            "SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
+				$start_at_record,
+				$num_items
+			),
+			ARRAY_A
+		);
+		$items_actually_migrated = 0;
+		foreach ($rows as $event_venue_rel) {
+			$this->_insert_new_event_to_venue_rel($event_venue_rel);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var(
+			"SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
             INNER JOIN " . $wpdb->prefix . 'events_detail AS e ON ev.event_id=e.id
             WHERE e.event_status!="D"'
-        );
-        return $count;
-    }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_venue_rel";
-        $this->_new_table = $wpdb->prefix."esp_event_venue";
-        $this->_pretty_name = __("Event to Venue Relations", "event_espresso");
-        parent::__construct();
-    }
+		);
+		return $count;
+	}
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_venue_rel";
+		$this->_new_table = $wpdb->prefix."esp_event_venue";
+		$this->_pretty_name = __("Event to Venue Relations", "event_espresso");
+		parent::__construct();
+	}
     
-    /**
-     * Attempts to insert a new question group inthe new format given an old one
-     * @global type $wpdb
-     * @param array $old_event_venue_rel
-     * @return int
-     */
-    private function _insert_new_event_to_venue_rel($old_event_venue_rel)
-    {
-        global $wpdb;
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
-        $new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
-            return 0;
-        }
-        if (! $new_venue_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
-            return 0;
-        }
-        // first ensure there are no other relation entries for this event
-        // because although EE4 supports it, EE3 didn't really
-        $wpdb->delete(
-            $this->_new_table,
-            array(
-                    'EVT_ID' => $new_event_id,
-                ),
-            array(
-                    '%d',// EVT_ID
-                )
-        );
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_event_venue_rel
+	 * @return int
+	 */
+	private function _insert_new_event_to_venue_rel($old_event_venue_rel)
+	{
+		global $wpdb;
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
+		$new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
+			return 0;
+		}
+		if (! $new_venue_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
+			return 0;
+		}
+		// first ensure there are no other relation entries for this event
+		// because although EE4 supports it, EE3 didn't really
+		$wpdb->delete(
+			$this->_new_table,
+			array(
+					'EVT_ID' => $new_event_id,
+				),
+			array(
+					'%d',// EVT_ID
+				)
+		);
 //      echo "last query". $wpdb->last_query;die;
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'VNU_ID'=>$new_venue_id,
-            'EVV_primary'=>true
-        );
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
-        );
-        $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'VNU_ID'=>$new_venue_id,
+			'EVV_primary'=>true
+		);
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// VNU_ID
+			'%d',// EVT_primary
+		);
+		$success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -42,7 +42,7 @@ 
         $rows = $wpdb->get_results(
             $wpdb->prepare(
                 "SELECT * FROM $this->_old_table AS ev 
-                    INNER JOIN " . $wpdb->prefix . "events_detail AS e ON ev.event_id=e.id
+                    INNER JOIN ".$wpdb->prefix."events_detail AS e ON ev.event_id=e.id
                     WHERE e.event_status!='D' LIMIT %d,%d",
                 $start_at_record,
                 $num_items
@@ -63,8 +63,8 @@ 
     {
         global $wpdb;
         $count = $wpdb->get_var(
-            "SELECT COUNT(ev.id) FROM ".$this->_old_table . " AS ev 
-            INNER JOIN " . $wpdb->prefix . 'events_detail AS e ON ev.event_id=e.id
+            "SELECT COUNT(ev.id) FROM ".$this->_old_table." AS ev 
+            INNER JOIN " . $wpdb->prefix.'events_detail AS e ON ev.event_id=e.id
             WHERE e.event_status!="D"'
         );
         return $count;
@@ -89,11 +89,11 @@ 
         global $wpdb;
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_venue_rel['event_id'], $wpdb->prefix."posts");
         $new_venue_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_venue", $old_event_venue_rel['venue_id'], $wpdb->prefix."posts");
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $old_event_venue_rel['event_id']));
             return 0;
         }
-        if (! $new_venue_id) {
+        if ( ! $new_venue_id) {
             $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $old_event_venue_rel['venue_id']));
             return 0;
         }
@@ -105,7 +105,7 @@ 
                     'EVT_ID' => $new_event_id,
                 ),
             array(
-                    '%d',// EVT_ID
+                    '%d', // EVT_ID
                 )
         );
 //      echo "last query". $wpdb->last_query;die;
@@ -115,12 +115,12 @@ 
             'EVV_primary'=>true
         );
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
+            '%d', // EVT_ID
+            '%d', // VNU_ID
+            '%d', // EVT_primary
         );
         $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event_venue_rel, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }

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

Indentation +75 added lines, -77 removed lines

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

core/domain/services/pue/Config.php

Indentation +127 added lines, -127 removed lines

@@ -16,131 +16,131 @@
  */
 class Config
 {
-    /**
-     * @var EE_Network_Config
-     */
-    private $network_config;
-
-
-    /**
-     * @var EE_Config
-     */
-    private $ee_config;
-
-
-    public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
-    {
-        $this->network_config = $network_config;
-        $this->ee_config = $ee_config;
-    }
-
-
-    /**
-     * Get the site license key for the site.
-     */
-    public function siteLicenseKey()
-    {
-        return $this->network_config->core->site_license_key;
-    }
-
-
-    public function i18nDomain()
-    {
-        return 'event_espresso';
-    }
-
-
-    public function checkPeriod()
-    {
-        return 24;
-    }
-
-
-    public function optionKey()
-    {
-        return 'ee_site_license_key';
-    }
-
-
-    public function optionsPageSlug()
-    {
-        return 'espresso_general_settings';
-    }
-
-
-    public function hostServerUrl()
-    {
-        return defined('PUE_UPDATES_ENDPOINT')
-            ? PUE_UPDATES_ENDPOINT
-            : 'https://eventespresso.com';
-    }
-
-
-    public function pluginSlug()
-    {
-        // Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
-        //  So it's important that you use a key for the version type that is unique and not found in another key.
-        // For example:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
-        // The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
-        // so doing something like:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
-        // ..WOULD work!
-        return array(
-            'free'       => array('decaf' => 'event-espresso-core-decaf'),
-            'premium'    => array('p' => 'event-espresso-core-reg'),
-            'prerelease' => array('beta' => 'event-espresso-core-pr'),
-        );
-    }
-
-
-    /**
-     * Return whether the site is opted in for UXIP or not.
-     *
-     * @return bool
-     */
-    public function isOptedInForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Return whether the site has been notified about UXIP or not.
-     *
-     * @return bool
-     */
-    public function hasNotifiedForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Set the site opted in for UXIP.
-     */
-    public function setHasOptedInForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    /**
-     * Set the site opted out for UXIP
-     */
-    public function setHasOptedOutForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = false;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    public function setHasNotifiedAboutUxip()
-    {
-        $this->ee_config->core->ee_ueip_has_notified = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
+	/**
+	 * @var EE_Network_Config
+	 */
+	private $network_config;
+
+
+	/**
+	 * @var EE_Config
+	 */
+	private $ee_config;
+
+
+	public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
+	{
+		$this->network_config = $network_config;
+		$this->ee_config = $ee_config;
+	}
+
+
+	/**
+	 * Get the site license key for the site.
+	 */
+	public function siteLicenseKey()
+	{
+		return $this->network_config->core->site_license_key;
+	}
+
+
+	public function i18nDomain()
+	{
+		return 'event_espresso';
+	}
+
+
+	public function checkPeriod()
+	{
+		return 24;
+	}
+
+
+	public function optionKey()
+	{
+		return 'ee_site_license_key';
+	}
+
+
+	public function optionsPageSlug()
+	{
+		return 'espresso_general_settings';
+	}
+
+
+	public function hostServerUrl()
+	{
+		return defined('PUE_UPDATES_ENDPOINT')
+			? PUE_UPDATES_ENDPOINT
+			: 'https://eventespresso.com';
+	}
+
+
+	public function pluginSlug()
+	{
+		// Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
+		//  So it's important that you use a key for the version type that is unique and not found in another key.
+		// For example:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
+		// The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
+		// so doing something like:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
+		// ..WOULD work!
+		return array(
+			'free'       => array('decaf' => 'event-espresso-core-decaf'),
+			'premium'    => array('p' => 'event-espresso-core-reg'),
+			'prerelease' => array('beta' => 'event-espresso-core-pr'),
+		);
+	}
+
+
+	/**
+	 * Return whether the site is opted in for UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function isOptedInForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Return whether the site has been notified about UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function hasNotifiedForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Set the site opted in for UXIP.
+	 */
+	public function setHasOptedInForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	/**
+	 * Set the site opted out for UXIP
+	 */
+	public function setHasOptedOutForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = false;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	public function setHasNotifiedAboutUxip()
+	{
+		$this->ee_config->core->ee_ueip_has_notified = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1161 added lines, -1161 removed lines

@@ -22,1225 +22,1225 @@
 class EE_Register_Addon implements EEI_Plugin_API
 {
 
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
 
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     * (first argument passed to EE_Register_Addon::register()), keys are
-     * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     * Generally this should be used sparingly, as we don't want to muddle up
-     * EE core with knowledge of ALL the addons out there.
-     * If you want NO versions of an addon to run with a certain version of core,
-     * it's usually best to define the addon's "min_core_version" as part of its call
-     * to EE_Register_Addon::register(), rather than using this array with a super high value for its
-     * minimum plugin version.
-     * @access    protected
-     */
-    protected static $_incompatible_addons = array(
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    );
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 * (first argument passed to EE_Register_Addon::register()), keys are
+	 * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 * Generally this should be used sparingly, as we don't want to muddle up
+	 * EE core with knowledge of ALL the addons out there.
+	 * If you want NO versions of an addon to run with a certain version of core,
+	 * it's usually best to define the addon's "min_core_version" as part of its call
+	 * to EE_Register_Addon::register(), rather than using this array with a super high value for its
+	 * minimum plugin version.
+	 * @access    protected
+	 */
+	protected static $_incompatible_addons = array(
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	);
 
 
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version($min_core_version)
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version($min_core_version)
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		// check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		// if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		// soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
 
 
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return boolean
-     */
-    public static function _meets_min_core_version_requirement(
-        $min_core_version,
-        $actual_core_version = EVENT_ESPRESSO_VERSION
-    ) {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return boolean
+	 */
+	public static function _meets_min_core_version_requirement(
+		$min_core_version,
+		$actual_core_version = EVENT_ESPRESSO_VERSION
+	) {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
 
 
-    /**
-     * Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @since    4.3.0
-     * @param string                  $addon_name                       [Required] the EE_Addon's name.
-     * @param  array                  $setup_args                       {
-     *                                                                  An array of arguments provided for registering
-     *                                                                  the message type.
-     * @type  string                  $class_name                       the addon's main file name.
-     *                                                                  If left blank, generated from the addon name,
-     *                                                                  changes something like "calendar" to
-     *                                                                  "EE_Calendar"
-     * @type string                   $min_core_version                 the minimum version of EE Core that the
-     *                                                                  addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                          the "software" version for the addon. eg
-     *                                                                  "1.0.0.p" for a first stable release, or
-     *                                                                  "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                   the full server path to the main file
-     *                                                                  loaded directly by WP
-     * @type DomainInterface $domain                                    child class of
-     *                                                                  EventEspresso\core\domain\DomainBase
-     * @type string                   $domain_fqcn                      Fully Qualified Class Name
-     *                                                                  for the addon's Domain class
-     *                                                                  (see EventEspresso\core\domain\Domain)
-     * @type string                   $admin_path                       full server path to the folder where the
-     *                                                                  addon\'s admin files reside
-     * @type string                   $admin_callback                   a method to be called when the EE Admin is
-     *                                                                  first invoked, can be used for hooking into
-     *                                                                  any admin page
-     * @type string                   $config_section                   the section name for this addon's
-     *                                                                  configuration settings section
-     *                                                                  (defaults to "addons")
-     * @type string                   $config_class                     the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $config_name                      the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $autoloader_paths                 [Required] an array of class names and the full
-     *                                                                  server paths to those files.
-     * @type string                   $autoloader_folders               an array of  "full server paths" for any
-     *                                                                  folders containing classes that might be
-     *                                                                  invoked by the addon
-     * @type string                   $dms_paths                        [Required] an array of full server paths to
-     *                                                                  folders that contain data migration scripts.
-     *                                                                  The key should be the EE_Addon class name that
-     *                                                                  this set of data migration scripts belongs to.
-     *                                                                  If the EE_Addon class is namespaced, then this
-     *                                                                  needs to be the Fully Qualified Class Name
-     * @type string                   $module_paths                     an array of full server paths to any
-     *                                                                  EED_Modules used by the addon
-     * @type string                   $shortcode_paths                  an array of full server paths to folders
-     *                                                                  that contain EES_Shortcodes
-     * @type string                   $widget_paths                     an array of full server paths to folders
-     *                                                                  that contain WP_Widgets
-     * @type string                   $pue_options
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @see      EE_Register_Model
-     * @type array                    $class_paths                      array of folders containing DB classes
-     * @see      EE_Register_Model
-     * @type array                    $model_extension_paths            array of folders containing DB model
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array                    $class_extension_paths            array of folders containing DB class
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                  An array of message types with the key as
-     *                                                                  the message type name and the values as
-     *                                                                  below:
-     * @type string                   $mtfilename                       [Required] The filename of the message type
-     *                                                                  being registered. This will be the main
-     *                                                                  EE_{Message Type Name}_message_type class.
-     *                                                                  for example:
-     *                                                                  EE_Declined_Registration_message_type.class.php
-     * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
-     *                                                                  messages autoloader for the new message type.
-     * @type array                    $messengers_to_activate_with      An array of messengers that this message
-     *                                                                  type should activate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of a
-     *                                                                  EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with      An array of messengers that this message
-     *                                                                  type should validate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of an
-     *                                                                  EE_messenger.
-     *                                                                  Optional.
-     *                                                                  }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths             each element is the folder containing the
-     *                                                                  EE_PMT_Base child class
-     *                                                                  (eg,
-     *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                  which contains the files
-     *                                                                  EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                        {
-     *                                                                  An array with two items for registering the
-     *                                                                  addon's namespace. (If, for some reason, you
-     *                                                                  require additional namespaces,
-     *                                                                  use
-     *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                  directly)
-     * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                             the namespace prefix
-     * @type string                   $DIR                              a base directory for class files in the
-     *                                                                  namespace.
-     *                                                                  }
-     *                                                                  }
-     * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        // setup $_settings array from incoming values.
-        $addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return;
-        }
-        // register namespaces
-        EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        EE_Register_Addon::_register_payment_methods($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPrivacyPolicies($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataExporters($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataErasers($addon_name);
-        // load and instantiate main addon class
-        $addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        // delay calling after_registration hook on each addon until after all add-ons have been registered.
-        add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
-    }
+	/**
+	 * Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @since    4.3.0
+	 * @param string                  $addon_name                       [Required] the EE_Addon's name.
+	 * @param  array                  $setup_args                       {
+	 *                                                                  An array of arguments provided for registering
+	 *                                                                  the message type.
+	 * @type  string                  $class_name                       the addon's main file name.
+	 *                                                                  If left blank, generated from the addon name,
+	 *                                                                  changes something like "calendar" to
+	 *                                                                  "EE_Calendar"
+	 * @type string                   $min_core_version                 the minimum version of EE Core that the
+	 *                                                                  addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                          the "software" version for the addon. eg
+	 *                                                                  "1.0.0.p" for a first stable release, or
+	 *                                                                  "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                   the full server path to the main file
+	 *                                                                  loaded directly by WP
+	 * @type DomainInterface $domain                                    child class of
+	 *                                                                  EventEspresso\core\domain\DomainBase
+	 * @type string                   $domain_fqcn                      Fully Qualified Class Name
+	 *                                                                  for the addon's Domain class
+	 *                                                                  (see EventEspresso\core\domain\Domain)
+	 * @type string                   $admin_path                       full server path to the folder where the
+	 *                                                                  addon\'s admin files reside
+	 * @type string                   $admin_callback                   a method to be called when the EE Admin is
+	 *                                                                  first invoked, can be used for hooking into
+	 *                                                                  any admin page
+	 * @type string                   $config_section                   the section name for this addon's
+	 *                                                                  configuration settings section
+	 *                                                                  (defaults to "addons")
+	 * @type string                   $config_class                     the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $config_name                      the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $autoloader_paths                 [Required] an array of class names and the full
+	 *                                                                  server paths to those files.
+	 * @type string                   $autoloader_folders               an array of  "full server paths" for any
+	 *                                                                  folders containing classes that might be
+	 *                                                                  invoked by the addon
+	 * @type string                   $dms_paths                        [Required] an array of full server paths to
+	 *                                                                  folders that contain data migration scripts.
+	 *                                                                  The key should be the EE_Addon class name that
+	 *                                                                  this set of data migration scripts belongs to.
+	 *                                                                  If the EE_Addon class is namespaced, then this
+	 *                                                                  needs to be the Fully Qualified Class Name
+	 * @type string                   $module_paths                     an array of full server paths to any
+	 *                                                                  EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                  an array of full server paths to folders
+	 *                                                                  that contain EES_Shortcodes
+	 * @type string                   $widget_paths                     an array of full server paths to folders
+	 *                                                                  that contain WP_Widgets
+	 * @type string                   $pue_options
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @see      EE_Register_Model
+	 * @type array                    $class_paths                      array of folders containing DB classes
+	 * @see      EE_Register_Model
+	 * @type array                    $model_extension_paths            array of folders containing DB model
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths            array of folders containing DB class
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                  An array of message types with the key as
+	 *                                                                  the message type name and the values as
+	 *                                                                  below:
+	 * @type string                   $mtfilename                       [Required] The filename of the message type
+	 *                                                                  being registered. This will be the main
+	 *                                                                  EE_{Message Type Name}_message_type class.
+	 *                                                                  for example:
+	 *                                                                  EE_Declined_Registration_message_type.class.php
+	 * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
+	 *                                                                  messages autoloader for the new message type.
+	 * @type array                    $messengers_to_activate_with      An array of messengers that this message
+	 *                                                                  type should activate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of a
+	 *                                                                  EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with      An array of messengers that this message
+	 *                                                                  type should validate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of an
+	 *                                                                  EE_messenger.
+	 *                                                                  Optional.
+	 *                                                                  }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths             each element is the folder containing the
+	 *                                                                  EE_PMT_Base child class
+	 *                                                                  (eg,
+	 *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                  which contains the files
+	 *                                                                  EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                        {
+	 *                                                                  An array with two items for registering the
+	 *                                                                  addon's namespace. (If, for some reason, you
+	 *                                                                  require additional namespaces,
+	 *                                                                  use
+	 *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                  directly)
+	 * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                             the namespace prefix
+	 * @type string                   $DIR                              a base directory for class files in the
+	 *                                                                  namespace.
+	 *                                                                  }
+	 *                                                                  }
+	 * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		// setup $_settings array from incoming values.
+		$addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return;
+		}
+		// register namespaces
+		EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		EE_Register_Addon::_register_payment_methods($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPrivacyPolicies($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataExporters($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataErasers($addon_name);
+		// load and instantiate main addon class
+		$addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		// delay calling after_registration hook on each addon until after all add-ons have been registered.
+		add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            // capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
-        return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
-            ? $class_name
-            : 'EE_' . $class_name;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			// capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		// check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
+		return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
+			? $class_name
+			: 'EE_' . $class_name;
+	}
 
 
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        // setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string) $setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string) $setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string) $setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string) $setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string) $setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string) $setup_args['main_file_path']
-                : '',
-            // instance of \EventEspresso\core\domain\DomainInterface
-            'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
-                ? $setup_args['domain']
-                : null,
-            // Fully Qualified Class Name for the addon's Domain class
-            'domain_fqcn'           => isset($setup_args['domain_fqcn'])
-                ? (string) $setup_args['domain_fqcn']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string) $setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string) $setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string) $setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string) $setup_args['config_class'] : '',
-            // the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string) $setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array) $setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array) $setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon.
-            // The key should be the EE_Addon class name that this set of data migration scripts belongs to.
-            // If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array) $setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array) $setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array) $setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array) $setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array) $setup_args['namespace']
-                : array(),
-            'privacy_policies'      => isset($setup_args['privacy_policies'])
-                ? (array) $setup_args['privacy_policies']
-                : '',
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		// setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string) $setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string) $setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string) $setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string) $setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string) $setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string) $setup_args['main_file_path']
+				: '',
+			// instance of \EventEspresso\core\domain\DomainInterface
+			'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
+				? $setup_args['domain']
+				: null,
+			// Fully Qualified Class Name for the addon's Domain class
+			'domain_fqcn'           => isset($setup_args['domain_fqcn'])
+				? (string) $setup_args['domain_fqcn']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string) $setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string) $setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string) $setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string) $setup_args['config_class'] : '',
+			// the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string) $setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array) $setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array) $setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon.
+			// The key should be the EE_Addon class name that this set of data migration scripts belongs to.
+			// If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array) $setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array) $setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array) $setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array) $setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array) $setup_args['namespace']
+				: array(),
+			'privacy_policies'      => isset($setup_args['privacy_policies'])
+				? (array) $setup_args['privacy_policies']
+				: '',
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
-    private static function _addon_is_compatible($addon_name, array $addon_settings)
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        // check whether this addon version is compatible with EE core
-        if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
+	private static function _addon_is_compatible($addon_name, array $addon_settings)
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		// check whether this addon version is compatible with EE core
+		if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
+					'event_espresso'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string) $setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string) $setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string) $setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
-    }
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[ $addon_name ]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string) $setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string) $setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string) $setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string) $setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
+	}
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (isset(
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (isset(
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _addon_activation($addon_name, array $addon_settings)
-    {
-        // this is an activation request
-        if (did_action(
-            'activate_plugin'
-        )) {// to find if THIS is the addon that was activated, just check if we have already registered it or not
-            // (as the newly-activated addon wasn't around the first time addons were registered).
-            // Note: the presence of pue_options in the addon registration options will initialize the $_settings
-            // property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
-                )
-            ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
-                $addon = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-        // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
-        } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
-        }
-        return false;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _addon_activation($addon_name, array $addon_settings)
+	{
+		// this is an activation request
+		if (did_action(
+			'activate_plugin'
+		)) {// to find if THIS is the addon that was activated, just check if we have already registered it or not
+			// (as the newly-activated addon wasn't around the first time addons were registered).
+			// Note: the presence of pue_options in the addon registration options will initialize the $_settings
+			// property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
+			if (! isset(self::$_settings[ $addon_name ])
+				|| (isset(self::$_settings[ $addon_name ])
+					&& ! isset(self::$_settings[ $addon_name ]['class_name'])
+				)
+			) {
+				self::$_settings[ $addon_name ] = $addon_settings;
+				$addon = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+		// make sure addon settings are set correctly without overwriting anything existing
+		if (isset(self::$_settings[ $addon_name ])) {
+			self::$_settings[ $addon_name ] += $addon_settings;
+		} else {
+			self::$_settings[ $addon_name ] = $addon_settings;
+		}
+		return false;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
+			foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
 
 
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_models_and_extensions($addon_name)
-    {
-        // register new models
-        if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
-                )
-            );
-        }
-    }
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_models_and_extensions($addon_name)
+	{
+		// register new models
+		if (! empty(self::$_settings[ $addon_name ]['model_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
+					'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_data_migration_scripts($addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_data_migration_scripts($addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_config($addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
-                array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_config($addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[ $addon_name ]['config_class'],
+				array(
+					'config_section' => self::$_settings[ $addon_name ]['config_section'],
+					'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_admin_pages($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_admin_pages($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_modules($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_modules($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_shortcodes($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
-                        : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
-                        : array(),
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_shortcodes($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array(
+					'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
+						? self::$_settings[ $addon_name ]['shortcode_paths']
+						: array(),
+					'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+						? self::$_settings[ $addon_name ]['shortcode_fqcns']
+						: array(),
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_widgets($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_widgets($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_capabilities($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_capabilities($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
+					'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_message_types($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_message_types($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_custom_post_types($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_custom_post_types($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
+			|| ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
+					'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
+					'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function _register_payment_methods($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function _register_payment_methods($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function registerPrivacyPolicies($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
-            EE_Register_Privacy_Policy::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function registerPrivacyPolicies($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+			EE_Register_Privacy_Policy::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['privacy_policies']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataExporters($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataExporters($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_exporters']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataErasers($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataErasers($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_erasers']
+			);
+		}
+	}
 
 
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
-        $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            array('EE_Registry::create(addon)' => true)
-        );
-        // setter inject dep map if required
-        if ($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null) {
-            $addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
-        }
-        // setter inject domain if required
-        if ($addon instanceof RequiresDomainInterface
-            && $addon->domain() === null
-        ) {
-            // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
-                : null;
-            // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
-                $domain = $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
-                    array(
-                        new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
-                        ),
-                        EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
-                        ),
-                    )
-                );
-            }
-            if ($domain instanceof DomainInterface) {
-                $addon->setDomain($domain);
-            }
-        }
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
-        // unfortunately this can't be hooked in upon construction, because we don't have
-        // the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
-            );
-        }
-        return $addon;
-    }
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
+		$addon = $loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			array('EE_Registry::create(addon)' => true)
+		);
+		// setter inject dep map if required
+		if ($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null) {
+			$addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
+		}
+		// setter inject domain if required
+		if ($addon instanceof RequiresDomainInterface
+			&& $addon->domain() === null
+		) {
+			// using supplied Domain object
+			$domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
+				? self::$_settings[ $addon_name ]['domain']
+				: null;
+			// or construct one using Domain FQCN
+			if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+				$domain = $loader->getShared(
+					self::$_settings[ $addon_name ]['domain_fqcn'],
+					array(
+						new EventEspresso\core\domain\values\FilePath(
+							self::$_settings[ $addon_name ]['main_file_path']
+						),
+						EventEspresso\core\domain\values\Version::fromString(
+							self::$_settings[ $addon_name ]['version']
+						),
+					)
+				);
+			}
+			if ($domain instanceof DomainInterface) {
+				$addon->setDomain($domain);
+			}
+		}
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
+		$addon->set_version(self::$_settings[ $addon_name ]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
+		$addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
+		$addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
+		$addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+		// unfortunately this can't be hooked in upon construction, because we don't have
+		// the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+			);
+		}
+		return $addon;
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_pue_update()
-    {
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
-        $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
-        // cycle thru settings
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // initiate the class and start the plugin update engine!
-                new PluginUpdateEngineChecker(
-                    // host file URL
-                    $license_server,
-                    // plugin slug(s)
-                    array(
-                        'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
-                    ),
-                    // options
-                    array(
-                        'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
-                        'lang_domain'       => 'event_espresso',
-                        'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                        'option_key'        => 'ee_site_license_key',
-                        'options_page_slug' => 'event_espresso',
-                        'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                        // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                        'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_pue_update()
+	{
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		$license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
+		// cycle thru settings
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// initiate the class and start the plugin update engine!
+				new PluginUpdateEngineChecker(
+					// host file URL
+					$license_server,
+					// plugin slug(s)
+					array(
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+					),
+					// options
+					array(
+						'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
+						'lang_domain'       => 'event_espresso',
+						'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+						'option_key'        => 'ee_site_license_key',
+						'options_page_slug' => 'event_espresso',
+						'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+						// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+						'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @since 4.4.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @since    4.3.0
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function deregister($addon_name = null)
-    {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
-            try {
-                do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-                    // setup DMS
-                    EE_Register_Data_Migration_Scripts::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-                    // register admin page
-                    EE_Register_Admin_Page::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-                    // add to list of modules to be registered
-                    EE_Register_Module::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Shortcode::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-                    // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-                    // add to list of widgets to be registered
-                    EE_Register_Widget::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model_Extensions::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
-                        EE_Register_Message_Type::deregister($message_type);
-                    }
-                }
-                // deregister capabilities for addon
-                if (! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
-                ) {
-                    EE_Register_Capabilities::deregister($addon_name);
-                }
-                // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
-                    EE_Register_CPT::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-                    EE_Register_Payment_Method::deregister($addon_name);
-                }
-                $addon = EE_Registry::instance()->getAddon($class_name);
-                if ($addon instanceof EE_Addon) {
-                    remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
-                        array($addon, 'deactivation')
-                    );
-                    remove_action(
-                        'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                        array($addon, 'initialize_db_if_no_migrations_required')
-                    );
-                    // remove `after_registration` call
-                    remove_action(
-                        'AHEE__EE_System__load_espresso_addons__complete',
-                        array($addon, 'after_registration'),
-                        999
-                    );
-                }
-                EE_Registry::instance()->removeAddon($class_name);
-            } catch (OutOfBoundsException $addon_not_yet_registered_exception) {
-                // the add-on was not yet registered in the registry,
-                // so RegistryContainer::__get() throws this exception.
-                // also no need to worry about this or log it,
-                // it's ok to deregister an add-on before its registered in the registry
-            } catch (Exception $e) {
-                new ExceptionLogger($e);
-            }
-            unset(self::$_settings[ $addon_name ]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function deregister($addon_name = null)
+	{
+		if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+			try {
+				do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+				$class_name = self::$_settings[ $addon_name ]['class_name'];
+				if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+					// setup DMS
+					EE_Register_Data_Migration_Scripts::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+					// register admin page
+					EE_Register_Admin_Page::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+					// add to list of modules to be registered
+					EE_Register_Module::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Shortcode::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+					// if config_class present let's register config.
+					EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+					// add to list of widgets to be registered
+					EE_Register_Widget::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['model_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model_Extensions::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+					foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+						EE_Register_Message_Type::deregister($message_type);
+					}
+				}
+				// deregister capabilities for addon
+				if (! empty(self::$_settings[ $addon_name ]['capabilities'])
+					|| ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+				) {
+					EE_Register_Capabilities::deregister($addon_name);
+				}
+				// deregister custom_post_types for addon
+				if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+					EE_Register_CPT::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+					EE_Register_Payment_Method::deregister($addon_name);
+				}
+				$addon = EE_Registry::instance()->getAddon($class_name);
+				if ($addon instanceof EE_Addon) {
+					remove_action(
+						'deactivate_' . $addon->get_main_plugin_file_basename(),
+						array($addon, 'deactivation')
+					);
+					remove_action(
+						'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+						array($addon, 'initialize_db_if_no_migrations_required')
+					);
+					// remove `after_registration` call
+					remove_action(
+						'AHEE__EE_System__load_espresso_addons__complete',
+						array($addon, 'after_registration'),
+						999
+					);
+				}
+				EE_Registry::instance()->removeAddon($class_name);
+			} catch (OutOfBoundsException $addon_not_yet_registered_exception) {
+				// the add-on was not yet registered in the registry,
+				// so RegistryContainer::__get() throws this exception.
+				// also no need to worry about this or log it,
+				// it's ok to deregister an add-on before its registered in the registry
+			} catch (Exception $e) {
+				new ExceptionLogger($e);
+			}
+			unset(self::$_settings[ $addon_name ]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
 }

Spacing +115 added lines, -115 removed lines

@@ -69,15 +69,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -264,7 +264,7 @@ 
         // setup PUE
         EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
         }
         // register namespaces
@@ -328,7 +328,7 @@ 
                 )
             );
         }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -340,7 +340,7 @@ 
             );
         }
         // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -372,7 +372,7 @@ 
         // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
         return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
             ? $class_name
-            : 'EE_' . $class_name;
+            : 'EE_'.$class_name;
     }
 
 
@@ -539,9 +539,9 @@ 
         global $wp_version;
         $incompatibility_message = '';
         // check whether this addon version is compatible with EE core
-        if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+        if (isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
             && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 $addon_settings['version']
             )
         ) {
@@ -552,11 +552,11 @@ 
                 ),
                 $addon_name,
                 '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 '<span style="font-weight: bold; color: #D54E21;">',
                 '</span><br />'
             );
-        } elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+        } elseif ( ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
         ) {
             $incompatibility_message = sprintf(
                 __(
@@ -583,7 +583,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             unset($_GET['activate'], $_REQUEST['activate']);
@@ -611,11 +611,11 @@ 
      */
     private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
     {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
+        if ( ! empty($setup_args['pue_options'])) {
+            self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
                     ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
                     ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
@@ -674,12 +674,12 @@ 
             // (as the newly-activated addon wasn't around the first time addons were registered).
             // Note: the presence of pue_options in the addon registration options will initialize the $_settings
             // property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
+            if ( ! isset(self::$_settings[$addon_name])
+                || (isset(self::$_settings[$addon_name])
+                    && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
             ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
+                self::$_settings[$addon_name] = $addon_settings;
                 $addon = self::_load_and_init_addon_class($addon_name);
                 $addon->set_activation_indicator_option();
                 // dont bother setting up the rest of the addon.
@@ -688,7 +688,7 @@ 
             return true;
         }
         // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
         ) {
             EE_Error::doing_it_wrong(
@@ -704,10 +704,10 @@ 
             );
         }
         // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
+        if (isset(self::$_settings[$addon_name])) {
+            self::$_settings[$addon_name] += $addon_settings;
         } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
+            self::$_settings[$addon_name] = $addon_settings;
         }
         return false;
     }
@@ -720,13 +720,13 @@ 
      */
     private static function _setup_autoloaders($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -743,26 +743,26 @@ 
     private static function _register_models_and_extensions($addon_name)
     {
         // register new models
-        if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+        if ( ! empty(self::$_settings[$addon_name]['model_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_paths'])
         ) {
             EE_Register_Model::register(
                 $addon_name,
                 array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
+                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
                 )
             );
         }
         // register model extensions
-        if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+        if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
         ) {
             EE_Register_Model_Extensions::register(
                 $addon_name,
                 array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
                 )
             );
         }
@@ -777,10 +777,10 @@ 
     private static function _register_data_migration_scripts($addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
             );
         }
     }
@@ -794,12 +794,12 @@ 
     private static function _register_config($addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
+                self::$_settings[$addon_name]['config_class'],
                 array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+                    'config_section' => self::$_settings[$addon_name]['config_section'],
+                    'config_name'    => self::$_settings[$addon_name]['config_name'],
                 )
             );
         }
@@ -813,10 +813,10 @@ 
      */
     private static function _register_admin_pages($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+                array('page_path' => self::$_settings[$addon_name]['admin_path'])
             );
         }
     }
@@ -829,10 +829,10 @@ 
      */
     private static function _register_modules($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
             );
         }
     }
@@ -845,17 +845,17 @@ 
      */
     private static function _register_shortcodes($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
         ) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
+                    'shortcode_paths' => isset(self::$_settings[$addon_name]['shortcode_paths'])
+                        ? self::$_settings[$addon_name]['shortcode_paths']
                         : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
+                    'shortcode_fqcns' => isset(self::$_settings[$addon_name]['shortcode_fqcns'])
+                        ? self::$_settings[$addon_name]['shortcode_fqcns']
                         : array(),
                 )
             );
@@ -870,10 +870,10 @@ 
      */
     private static function _register_widgets($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
             );
         }
     }
@@ -886,12 +886,12 @@ 
      */
     private static function _register_capabilities($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
                 )
             );
         }
@@ -905,7 +905,7 @@ 
      */
     private static function _register_message_types($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 array('EE_Register_Addon', 'register_message_types')
@@ -921,15 +921,15 @@ 
      */
     private static function _register_custom_post_types($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+        if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])
+            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
         ) {
             EE_Register_CPT::register(
                 $addon_name,
                 array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
                 )
             );
         }
@@ -947,10 +947,10 @@ 
      */
     private static function _register_payment_methods($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
             );
         }
     }
@@ -967,10 +967,10 @@ 
      */
     private static function registerPrivacyPolicies($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+        if ( ! empty(self::$_settings[$addon_name]['privacy_policies'])) {
             EE_Register_Privacy_Policy::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
+                self::$_settings[$addon_name]['privacy_policies']
             );
         }
     }
@@ -982,10 +982,10 @@ 
      */
     private static function registerPersonalDataExporters($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_exporters'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
+                self::$_settings[$addon_name]['personal_data_exporters']
             );
         }
     }
@@ -997,10 +997,10 @@ 
      */
     private static function registerPersonalDataErasers($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_erasers'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
+                self::$_settings[$addon_name]['personal_data_erasers']
             );
         }
     }
@@ -1021,7 +1021,7 @@ 
     {
         $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
         $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             array('EE_Registry::create(addon)' => true)
         );
         // setter inject dep map if required
@@ -1033,19 +1033,19 @@ 
             && $addon->domain() === null
         ) {
             // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
+            $domain = self::$_settings[$addon_name]['domain'] instanceof DomainInterface
+                ? self::$_settings[$addon_name]['domain']
                 : null;
             // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+            if ($domain === null && self::$_settings[$addon_name]['domain_fqcn'] !== '') {
                 $domain = $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     array(
                         new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
+                            self::$_settings[$addon_name]['main_file_path']
                         ),
                         EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
+                            self::$_settings[$addon_name]['version']
                         ),
                     )
                 );
@@ -1055,24 +1055,24 @@ 
             }
         }
         $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+        $addon->set_version(self::$_settings[$addon_name]['version']);
+        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
         // unfortunately this can't be hooked in upon construction, because we don't have
         // the plugin mainfile's path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+                array($addon, self::$_settings[$addon_name]['admin_callback'])
             );
         }
         return $addon;
@@ -1090,11 +1090,11 @@ 
     public static function load_pue_update()
     {
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+        require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
         $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
         // cycle thru settings
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
+            if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
                 new PluginUpdateEngineChecker(
                     // host file URL
@@ -1102,7 +1102,7 @@ 
                     // plugin slug(s)
                     array(
                         'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
                     ),
                     // options
                     array(
@@ -1131,7 +1131,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
+            if ( ! empty($settings['message_types'])) {
                 foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
@@ -1153,70 +1153,70 @@ 
      */
     public static function deregister($addon_name = null)
     {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+        if (isset(self::$_settings[$addon_name]['class_name'])) {
             try {
                 do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+                $class_name = self::$_settings[$addon_name]['class_name'];
+                if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                     // setup DMS
                     EE_Register_Data_Migration_Scripts::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+                if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                     // register admin page
                     EE_Register_Admin_Page::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                     // add to list of modules to be registered
                     EE_Register_Module::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+                if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+                    || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Shortcode::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+                if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                     // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+                    EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                     // add to list of widgets to be registered
                     EE_Register_Widget::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model_Extensions::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+                if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+                    foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
                         EE_Register_Message_Type::deregister($message_type);
                     }
                 }
                 // deregister capabilities for addon
-                if (! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+                if ( ! empty(self::$_settings[$addon_name]['capabilities'])
+                    || ! empty(self::$_settings[$addon_name]['capability_maps'])
                 ) {
                     EE_Register_Capabilities::deregister($addon_name);
                 }
                 // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                     EE_Register_CPT::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
                     EE_Register_Payment_Method::deregister($addon_name);
                 }
                 $addon = EE_Registry::instance()->getAddon($class_name);
                 if ($addon instanceof EE_Addon) {
                     remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
+                        'deactivate_'.$addon->get_main_plugin_file_basename(),
                         array($addon, 'deactivation')
                     );
                     remove_action(
@@ -1239,7 +1239,7 @@ 
             } catch (Exception $e) {
                 new ExceptionLogger($e);
             }
-            unset(self::$_settings[ $addon_name ]);
+            unset(self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
         }
     }

core/libraries/rest_api/controllers/model/Read.php

Spacing +55 added lines, -55 removed lines

@@ -64,7 +64,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -102,7 +102,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -159,11 +159,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -172,9 +172,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -196,9 +196,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -238,7 +238,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -283,7 +283,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -298,7 +298,7 @@ 
                 );
             }
             $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -335,7 +335,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -347,7 +347,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -382,7 +382,7 @@ 
         $context = $this->validateContext($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         // check if they can access the 1st model object
@@ -399,7 +399,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('main model query params', $restricted_query_params);
         $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $model->exists($restricted_query_params)
         )
@@ -432,13 +432,13 @@ 
         }
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -489,7 +489,7 @@ 
      */
     public function getEntitiesFromRelation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -531,7 +531,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -564,7 +564,7 @@ 
      */
     public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -645,8 +645,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -656,7 +656,7 @@ 
                     )
                 );
             }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
+            $model_object_classname = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -667,13 +667,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -682,7 +682,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -709,10 +709,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name] = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -764,7 +764,7 @@ 
     protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -789,7 +789,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -805,12 +805,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -839,13 +839,13 @@ 
         $db_row = array()
     ) {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -891,7 +891,7 @@ 
                     $relation_obj,
                     $pretend_related_request
                 );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results
                                                                                              instanceof
                                                                                              WP_Error
                     ? null
@@ -1023,7 +1023,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1048,7 +1048,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = EEM_Base::default_where_conditions_all;
         }
         if (in_array(
@@ -1131,14 +1131,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
+            if ( ! is_array($query_parameters['limit'])) {
                 $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -1184,9 +1184,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1204,9 +1204,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1238,17 +1238,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1287,9 +1287,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1329,7 +1329,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 array_shift($model_rows),
@@ -1339,10 +1339,10 @@ 
             // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
             $lowercase_model_name = strtolower($model->get_this_model_name());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 // you got shafted- it existed but we didn't want to tell you!
                 return new WP_Error(
-                    'rest_user_cannot_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,

Indentation +1333 added lines, -1333 removed lines

@@ -35,1337 +35,1337 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->fields_calculator = new CalculatedModelFields();
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version    The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model);
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return array();
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     */
-    protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @param string          $related_model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $related_model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return WP_Error|array
-     * @throws RestException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return array|WP_Error
-     * @throws EE_Error
-     */
-    public function getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     */
-    protected function setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request $rest_request
-     * @param string          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->getModelVersionInfo(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     */
-    protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param EEM_Base         $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param array           $entity_array
-     * @param array           $db_row
-     * @return array the modified entity
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
-                                                                                             instanceof
-                                                                                             WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function removeModelNamesFromArray($arr)
-    {
-        return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @return \stdClass the _calculations item in the entity
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
-                    null,
-                    $this->fields_calculator->retrieveCalculatedFieldValue(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext($context)
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return EEM_Base::caps_read;
-        }
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validateDefaultQueryParams($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = EEM_Base::default_where_conditions_all;
-        }
-        if (in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )) {
-            return $default_query_params;
-        } else {
-            return EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-    /**
-     * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param EEM_Base $model
-     * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
-     * @return array like what EEM_Base::get_all() expects or FALSE to indicate
-     *                                    that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string) $query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_parameters['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_parameters['default_where_conditions']
-            );
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extractIncludesForThisModel($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array|WP_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                array_shift($model_rows),
-                $request
-            );
-        } else {
-            // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                // you got shafted- it existed but we didn't want to tell you!
-                return new WP_Error(
-                    'rest_user_cannot_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                // it's not you. It just doesn't exist
-                return new WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->fields_calculator = new CalculatedModelFields();
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version    The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return array();
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 */
+	protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @param string          $related_model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$related_model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return WP_Error|array
+	 * @throws RestException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return array|WP_Error
+	 * @throws EE_Error
+	 */
+	public function getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 */
+	protected function setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request $rest_request
+	 * @param string          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->getModelVersionInfo(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ] = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 */
+	protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param EEM_Base         $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array           $entity_array
+	 * @param array           $db_row
+	 * @return array the modified entity
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+																							 instanceof
+																							 WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function removeModelNamesFromArray($arr)
+	{
+		return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @return \stdClass the _calculations item in the entity
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
+					null,
+					$this->fields_calculator->retrieveCalculatedFieldValue(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext($context)
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return EEM_Base::caps_read;
+		}
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validateDefaultQueryParams($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = EEM_Base::default_where_conditions_all;
+		}
+		if (in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)) {
+			return $default_query_params;
+		} else {
+			return EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+	/**
+	 * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
+	 * @return array like what EEM_Base::get_all() expects or FALSE to indicate
+	 *                                    that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string) $query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_parameters['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_parameters['default_where_conditions']
+			);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extractIncludesForThisModel($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array|WP_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				array_shift($model_rows),
+				$request
+			);
+		} else {
+			// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				// you got shafted- it existed but we didn't want to tell you!
+				return new WP_Error(
+					'rest_user_cannot_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						strtolower($model->get_this_model_name()),
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					array('status' => 403)
+				);
+			} else {
+				// it's not you. It just doesn't exist
+				return new WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
 }

core/libraries/rest_api/ModelDataTranslator.php

Indentation +832 added lines, -832 removed lines

@@ -32,836 +32,836 @@
 class ModelDataTranslator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const EE_INF_IN_REST = null;
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     */
-    public static function prepareFieldValuesFromJson(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)
-            && ! $field_obj instanceof EE_Serialized_Text_Field
-        ) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value = array();
-            foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $value,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function prepareFieldValueFromJson(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    ) {
-        // check if they accidentally submitted an error value. If so throw an exception
-        if (is_array($original_value)
-            && isset($original_value['error_code'], $original_value['error_message'])) {
-            throw new RestException(
-                'rest_submitted_error_value',
-                sprintf(
-                    esc_html__(
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_name()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        // double-check for serialized PHP. We never accept serialized PHP. No way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        // walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
-        // way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        if ($field_obj instanceof EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            $new_value = rest_parse_date(
-                self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
-            );
-            if ($new_value === false) {
-                throw new RestException(
-                    'invalid_format_for_timestamp',
-                    sprintf(
-                        esc_html__(
-                            'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
-                            'event_espresso'
-                        ),
-                        'RFC3339',
-                        'ISO8601',
-                        $original_value
-                    ),
-                    array(
-                        'status' => 400,
-                    )
-                );
-            }
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
-     * information via details obtained from the host site.
-     *
-     * @param string            $original_timestamp
-     * @param EE_Datetime_Field $datetime_field
-     * @param                   $timezone_string
-     * @return string
-     * @throws DomainException
-     */
-    private static function getTimestampWithTimezoneOffset(
-        $original_timestamp,
-        EE_Datetime_Field $datetime_field,
-        $timezone_string
-    ) {
-        // already have timezone information?
-        if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
-            // yes, we're ignoring the timezone.
-            return $original_timestamp;
-        }
-        // need to append timezone
-        list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
-            $datetime_field->get_timezone_offset(
-                new \DateTimeZone($timezone_string),
-                $original_timestamp
-            )
-        );
-        $offset_string =
-            str_pad(
-                floor($offset_secs / HOUR_IN_SECONDS),
-                2,
-                '0',
-                STR_PAD_LEFT
-            )
-            . ':'
-            . str_pad(
-                ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                2,
-                '0',
-                STR_PAD_LEFT
-            );
-        return $original_timestamp . $offset_sign . $offset_string;
-    }
-
-
-    /**
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
-     * think that can happen). If $data is an array, recurses into its keys and values
-     *
-     * @param mixed $data
-     * @throws RestException
-     * @return void
-     */
-    public static function throwExceptionIfContainsSerializedData($data)
-    {
-        if (is_array($data)) {
-            foreach ($data as $key => $value) {
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
-            }
-        } else {
-            if (is_serialized($data) || is_object($data)) {
-                throw new RestException(
-                    'serialized_data_submission_prohibited',
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parseTimezoneOffset($timezone_offset)
-    {
-        $first_char = substr((string) $timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string) $timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @return mixed
-     */
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            if (is_string($original_value)) {
-                // did they submit a string of a unix timestamp?
-                if (is_numeric($original_value)) {
-                    $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int) $original_value);
-                } else {
-                    // first, check if its a MySQL timestamp in GMT
-                    $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
-                }
-                if (! $datetime_obj instanceof \DateTime) {
-                    // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
-                }
-                $original_value = $datetime_obj;
-            }
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value) || is_float($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif ($original_value === null || $original_value === '') {
-                $new_value = null;
-            } else {
-                // so it's not a datetime object, unix timestamp (as string or int),
-                // MySQL timestamp, or even a string in the field object's format. So no idea what it is
-                throw new \EE_Error(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $original_value,
-                        $field_obj->get_name(),
-                        $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
-                    )
-                );
-            }
-            if ($new_value !== null) {
-                $new_value = mysql_to_rfc3339($new_value);
-            }
-        } else {
-            $new_value = $original_value;
-        }
-        // are we about to send an object? just don't. We have no good way to represent it in JSON.
-        // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
-            $new_value = array(
-                'error_code'    => 'php_object_not_return',
-                'error_message' => esc_html__(
-                    'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
-                    'event_espresso'
-                ),
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array    $inputted_query_params_of_this_type
-     * @param EEM_Base $model
-     * @param string   $requested_version
-     * @param boolean  $writing whether this data will be written to the DB, or if we're just building a query.
-     *                          If we're writing to the DB, we don't expect any operators, or any logic query
-     *                          parameters, and we also won't accept serialized data unless the current user has
-     *                          unfiltered_html.
-     * @return array
-     * @throws DomainException
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function prepareConditionsQueryParamsForModels(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version,
-        $writing = false
-    ) {
-        $query_param_for_models = array();
-        $valid_operators = $model->valid_operators();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $is_gmt_datetime_field = false;
-            $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-                $query_param_key
-            );
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                $query_param_sans_stars,
-                $model
-            );
-            // double-check is it a *_gmt field?
-            if (! $field instanceof EE_Model_Field_Base
-                && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
-            ) {
-                // yep, take off '_gmt', and find the field
-                $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
-                $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-                $is_gmt_datetime_field = true;
-            } elseif ($field instanceof EE_Datetime_Field) {
-                // so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            } else {
-                // just keep using what's already set for the timezone
-                $timezone = $model->get_timezone();
-            }
-            if ($field instanceof EE_Model_Field_Base) {
-                if (! $writing && is_array($query_param_value)) {
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'numerically_indexed_array_of_values_only',
-                                sprintf(
-                                    esc_html__(
-                                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                    }
-                    // did they specify an operator?
-                    if (isset($query_param_value[0])
-                        && isset($valid_operators[ $query_param_value[0] ])
-                    ) {
-                        $op = $query_param_value[0];
-                        $translated_value = array($op);
-                        if (array_key_exists($op, $model->valid_in_style_operators())
-                            && isset($query_param_value[1])
-                            && ! isset($query_param_value[2])
-                        ) {
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } elseif (array_key_exists($op, $model->valid_between_style_operators())
-                                  && isset($query_param_value[1])
-                                  && is_array($query_param_value[1])
-                                  && isset($query_param_key[1][0], $query_param_value[1][1])
-                                  && ! isset($query_param_value[1][2])
-                                  && ! isset($query_param_value[2])
-                        ) {
-                            $translated_value[] = array(
-                                ModelDataTranslator::prepareFieldValuesFromJson(
-                                    $field,
-                                    $query_param_value[1][0],
-                                    $requested_version,
-                                    $timezone
-                                ),
-                                ModelDataTranslator::prepareFieldValuesFromJson(
-                                    $field,
-                                    $query_param_value[1][1],
-                                    $requested_version,
-                                    $timezone
-                                )
-                            );
-                        } elseif (array_key_exists($op, $model->valid_like_style_operators())
-                                  && isset($query_param_value[1])
-                                  && ! isset($query_param_value[2])
-                        ) {
-                            // we want to leave this value mostly-as-is (eg don't force it to be a float
-                            // or a boolean or an enum value. Leave it as-is with wildcards etc)
-                            // but do verify it at least doesn't have any serialized data
-                            ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                            $translated_value[] = $query_param_value[1];
-                        } elseif (array_key_exists($op, $model->valid_null_style_operators())
-                                  && ! isset($query_param_value[1])) {
-                            // no arguments should have been provided, so don't look for any
-                        } elseif (isset($query_param_value[1])
-                                  && ! isset($query_param_value[2])
-                                  && ! array_key_exists(
-                                      $op,
-                                      array_merge(
-                                          $model->valid_in_style_operators(),
-                                          $model->valid_null_style_operators(),
-                                          $model->valid_like_style_operators(),
-                                          $model->valid_between_style_operators()
-                                      )
-                                  )
-                        ) {
-                            // it's a valid operator, but none of the exceptions. Treat it normally.
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } else {
-                            // so they provided a valid operator, but wrong number of arguments
-                            if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                                throw new RestException(
-                                    'wrong_number_of_arguments',
-                                    sprintf(
-                                        esc_html__(
-                                            'The operator you provided, "%1$s" had the wrong number of arguments',
-                                            'event_espresso'
-                                        ),
-                                        $op
-                                    ),
-                                    array(
-                                        'status' => 400,
-                                    )
-                                );
-                            }
-                            $translated_value = null;
-                        }
-                    } else {
-                        // so they didn't provide a valid operator
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'invalid_operator',
-                                sprintf(
-                                    esc_html__(
-                                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key,
-                                    $query_param_value
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                        // if we aren't in debug mode, then just try our best to fulfill the user's request
-                        $translated_value = null;
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueFromJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version,
-                        $timezone
-                    );
-                }
-                if ((isset($query_param_for_models[ $query_param_key ]) && $is_gmt_datetime_field)
-                    || $translated_value === null
-                ) {
-                    // they have already provided a non-gmt field, ignore the gmt one. That's what WP core
-                    // currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
-                    // OR we couldn't create a translated value from their input
-                    continue;
-                }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
-            } else {
-                // so this param doesn't correspond to a field eh?
-                if ($writing) {
-                    // always tell API clients about invalid parameters when they're creating data. Otherwise,
-                    // they are probably going to create invalid data
-                    throw new RestException(
-                        'invalid_field',
-                        sprintf(
-                            esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                            $query_param_key
-                        )
-                    );
-                } else {
-                    // so it's not for a field, is it a logic query param key?
-                    if (in_array(
-                        $query_param_sans_stars,
-                        $model->logic_query_param_keys()
-                    )) {
-                        $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                            $query_param_value,
-                            $model,
-                            $requested_version
-                        );
-                    } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                        // only tell API clients they got it wrong if we're in debug mode
-                        // otherwise try our best ot fulfill their request by ignoring this invalid data
-                        throw new RestException(
-                            'invalid_parameter',
-                            sprintf(
-                                esc_html__(
-                                    'You provided an invalid parameter, with key "%1$s"',
-                                    'event_espresso'
-                                ),
-                                $query_param_sans_stars
-                            ),
-                            array(
-                                'status' => 400,
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function isGmtDateFieldName($field_name)
-    {
-        return substr(
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
-            -4,
-            4
-        ) === '_gmt';
-    }
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function removeGmtFromFieldName($field_name)
-    {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $field_name
-        );
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepareFieldNameFromJson($field_name)
-    {
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
-        }
-        return $field_name;
-    }
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepareFieldNamesFromJson(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array    $model_query_params
-     * @param EEM_Base $model
-     * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws EE_Error
-     */
-    public static function prepareQueryParamsForRestApi(
-        array $model_query_params,
-        EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params,
-            $model_query_params,
-            $model,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param EEM_Base $model
-     * @param string   $requested_version                   eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws EE_Error
-     * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
-     *                                                      (which would be really unusual)
-     */
-    public static function prepareConditionsQueryParamsForRestApi(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
-                $model
-            );
-            if ($field instanceof EE_Model_Field_Base) {
-                // did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
-                            $field,
-                            $value,
-                            $requested_version
-                        );
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version
-                    );
-                }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
-            } else {
-                // so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                    $query_param_value,
-                    $model,
-                    $requested_version
-                );
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param EEM_Base $model
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
-    {
-        // ok, now proceed with deducing which part is the model's name, and which is the field's name
-        // which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            // the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
-        }
-        try {
-            return $model->field_settings_for($field_name, false);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-    /**
-     * Returns true if $data can be easily represented in JSON.
-     * Basically, objects and resources can't be represented in JSON easily.
-     *
-     * @param mixed $data
-     * @return bool
-     */
-    protected static function isRepresentableInJson($data)
-    {
-        return is_scalar($data)
-               || is_array($data)
-               || is_null($data);
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const EE_INF_IN_REST = null;
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 */
+	public static function prepareFieldValuesFromJson(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
+		) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value = array();
+			foreach ($original_value_maybe_array as $key => $value) {
+				$new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$value,
+					$request_version
+				);
+			}
+		} else {
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValueFromJson(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	) {
+		// check if they accidentally submitted an error value. If so throw an exception
+		if (is_array($original_value)
+			&& isset($original_value['error_code'], $original_value['error_message'])) {
+			throw new RestException(
+				'rest_submitted_error_value',
+				sprintf(
+					esc_html__(
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
+						'event_espresso'
+					),
+					$field_obj->get_name()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		// double-check for serialized PHP. We never accept serialized PHP. No way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		// walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
+		// way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		if ($field_obj instanceof EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			$new_value = rest_parse_date(
+				self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
+			);
+			if ($new_value === false) {
+				throw new RestException(
+					'invalid_format_for_timestamp',
+					sprintf(
+						esc_html__(
+							'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
+							'event_espresso'
+						),
+						'RFC3339',
+						'ISO8601',
+						$original_value
+					),
+					array(
+						'status' => 400,
+					)
+				);
+			}
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
+	 * information via details obtained from the host site.
+	 *
+	 * @param string            $original_timestamp
+	 * @param EE_Datetime_Field $datetime_field
+	 * @param                   $timezone_string
+	 * @return string
+	 * @throws DomainException
+	 */
+	private static function getTimestampWithTimezoneOffset(
+		$original_timestamp,
+		EE_Datetime_Field $datetime_field,
+		$timezone_string
+	) {
+		// already have timezone information?
+		if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
+			// yes, we're ignoring the timezone.
+			return $original_timestamp;
+		}
+		// need to append timezone
+		list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
+			$datetime_field->get_timezone_offset(
+				new \DateTimeZone($timezone_string),
+				$original_timestamp
+			)
+		);
+		$offset_string =
+			str_pad(
+				floor($offset_secs / HOUR_IN_SECONDS),
+				2,
+				'0',
+				STR_PAD_LEFT
+			)
+			. ':'
+			. str_pad(
+				($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+				2,
+				'0',
+				STR_PAD_LEFT
+			);
+		return $original_timestamp . $offset_sign . $offset_string;
+	}
+
+
+	/**
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
+	 * think that can happen). If $data is an array, recurses into its keys and values
+	 *
+	 * @param mixed $data
+	 * @throws RestException
+	 * @return void
+	 */
+	public static function throwExceptionIfContainsSerializedData($data)
+	{
+		if (is_array($data)) {
+			foreach ($data as $key => $value) {
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
+			}
+		} else {
+			if (is_serialized($data) || is_object($data)) {
+				throw new RestException(
+					'serialized_data_submission_prohibited',
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parseTimezoneOffset($timezone_offset)
+	{
+		$first_char = substr((string) $timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string) $timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @return mixed
+	 */
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			if (is_string($original_value)) {
+				// did they submit a string of a unix timestamp?
+				if (is_numeric($original_value)) {
+					$datetime_obj = new \DateTime();
+					$datetime_obj->setTimestamp((int) $original_value);
+				} else {
+					// first, check if its a MySQL timestamp in GMT
+					$datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
+				}
+				if (! $datetime_obj instanceof \DateTime) {
+					// so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
+				}
+				$original_value = $datetime_obj;
+			}
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value) || is_float($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} elseif ($original_value === null || $original_value === '') {
+				$new_value = null;
+			} else {
+				// so it's not a datetime object, unix timestamp (as string or int),
+				// MySQL timestamp, or even a string in the field object's format. So no idea what it is
+				throw new \EE_Error(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$original_value,
+						$field_obj->get_name(),
+						$field_obj->get_model_name(),
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+					)
+				);
+			}
+			if ($new_value !== null) {
+				$new_value = mysql_to_rfc3339($new_value);
+			}
+		} else {
+			$new_value = $original_value;
+		}
+		// are we about to send an object? just don't. We have no good way to represent it in JSON.
+		// can't just check using is_object() because that missed PHP incomplete objects
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+			$new_value = array(
+				'error_code'    => 'php_object_not_return',
+				'error_message' => esc_html__(
+					'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
+					'event_espresso'
+				),
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array    $inputted_query_params_of_this_type
+	 * @param EEM_Base $model
+	 * @param string   $requested_version
+	 * @param boolean  $writing whether this data will be written to the DB, or if we're just building a query.
+	 *                          If we're writing to the DB, we don't expect any operators, or any logic query
+	 *                          parameters, and we also won't accept serialized data unless the current user has
+	 *                          unfiltered_html.
+	 * @return array
+	 * @throws DomainException
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function prepareConditionsQueryParamsForModels(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version,
+		$writing = false
+	) {
+		$query_param_for_models = array();
+		$valid_operators = $model->valid_operators();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$is_gmt_datetime_field = false;
+			$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+				$query_param_key
+			);
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				$query_param_sans_stars,
+				$model
+			);
+			// double-check is it a *_gmt field?
+			if (! $field instanceof EE_Model_Field_Base
+				&& ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
+			) {
+				// yep, take off '_gmt', and find the field
+				$query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
+				$field = ModelDataTranslator::deduceFieldFromQueryParam(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+				$is_gmt_datetime_field = true;
+			} elseif ($field instanceof EE_Datetime_Field) {
+				// so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			} else {
+				// just keep using what's already set for the timezone
+				$timezone = $model->get_timezone();
+			}
+			if ($field instanceof EE_Model_Field_Base) {
+				if (! $writing && is_array($query_param_value)) {
+					if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'numerically_indexed_array_of_values_only',
+								sprintf(
+									esc_html__(
+										'The array provided for the parameter "%1$s" should be numerically indexed.',
+										'event_espresso'
+									),
+									$query_param_key
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+					}
+					// did they specify an operator?
+					if (isset($query_param_value[0])
+						&& isset($valid_operators[ $query_param_value[0] ])
+					) {
+						$op = $query_param_value[0];
+						$translated_value = array($op);
+						if (array_key_exists($op, $model->valid_in_style_operators())
+							&& isset($query_param_value[1])
+							&& ! isset($query_param_value[2])
+						) {
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} elseif (array_key_exists($op, $model->valid_between_style_operators())
+								  && isset($query_param_value[1])
+								  && is_array($query_param_value[1])
+								  && isset($query_param_key[1][0], $query_param_value[1][1])
+								  && ! isset($query_param_value[1][2])
+								  && ! isset($query_param_value[2])
+						) {
+							$translated_value[] = array(
+								ModelDataTranslator::prepareFieldValuesFromJson(
+									$field,
+									$query_param_value[1][0],
+									$requested_version,
+									$timezone
+								),
+								ModelDataTranslator::prepareFieldValuesFromJson(
+									$field,
+									$query_param_value[1][1],
+									$requested_version,
+									$timezone
+								)
+							);
+						} elseif (array_key_exists($op, $model->valid_like_style_operators())
+								  && isset($query_param_value[1])
+								  && ! isset($query_param_value[2])
+						) {
+							// we want to leave this value mostly-as-is (eg don't force it to be a float
+							// or a boolean or an enum value. Leave it as-is with wildcards etc)
+							// but do verify it at least doesn't have any serialized data
+							ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+							$translated_value[] = $query_param_value[1];
+						} elseif (array_key_exists($op, $model->valid_null_style_operators())
+								  && ! isset($query_param_value[1])) {
+							// no arguments should have been provided, so don't look for any
+						} elseif (isset($query_param_value[1])
+								  && ! isset($query_param_value[2])
+								  && ! array_key_exists(
+									  $op,
+									  array_merge(
+										  $model->valid_in_style_operators(),
+										  $model->valid_null_style_operators(),
+										  $model->valid_like_style_operators(),
+										  $model->valid_between_style_operators()
+									  )
+								  )
+						) {
+							// it's a valid operator, but none of the exceptions. Treat it normally.
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} else {
+							// so they provided a valid operator, but wrong number of arguments
+							if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+								throw new RestException(
+									'wrong_number_of_arguments',
+									sprintf(
+										esc_html__(
+											'The operator you provided, "%1$s" had the wrong number of arguments',
+											'event_espresso'
+										),
+										$op
+									),
+									array(
+										'status' => 400,
+									)
+								);
+							}
+							$translated_value = null;
+						}
+					} else {
+						// so they didn't provide a valid operator
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'invalid_operator',
+								sprintf(
+									esc_html__(
+										'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+										'event_espresso'
+									),
+									$query_param_key,
+									$query_param_value
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+						// if we aren't in debug mode, then just try our best to fulfill the user's request
+						$translated_value = null;
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueFromJson(
+						$field,
+						$query_param_value,
+						$requested_version,
+						$timezone
+					);
+				}
+				if ((isset($query_param_for_models[ $query_param_key ]) && $is_gmt_datetime_field)
+					|| $translated_value === null
+				) {
+					// they have already provided a non-gmt field, ignore the gmt one. That's what WP core
+					// currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
+					// OR we couldn't create a translated value from their input
+					continue;
+				}
+				$query_param_for_models[ $query_param_key ] = $translated_value;
+			} else {
+				// so this param doesn't correspond to a field eh?
+				if ($writing) {
+					// always tell API clients about invalid parameters when they're creating data. Otherwise,
+					// they are probably going to create invalid data
+					throw new RestException(
+						'invalid_field',
+						sprintf(
+							esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+							$query_param_key
+						)
+					);
+				} else {
+					// so it's not for a field, is it a logic query param key?
+					if (in_array(
+						$query_param_sans_stars,
+						$model->logic_query_param_keys()
+					)) {
+						$query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+							$query_param_value,
+							$model,
+							$requested_version
+						);
+					} elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+						// only tell API clients they got it wrong if we're in debug mode
+						// otherwise try our best ot fulfill their request by ignoring this invalid data
+						throw new RestException(
+							'invalid_parameter',
+							sprintf(
+								esc_html__(
+									'You provided an invalid parameter, with key "%1$s"',
+									'event_espresso'
+								),
+								$query_param_sans_stars
+							),
+							array(
+								'status' => 400,
+							)
+						);
+					}
+				}
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function isGmtDateFieldName($field_name)
+	{
+		return substr(
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
+			-4,
+			4
+		) === '_gmt';
+	}
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function removeGmtFromFieldName($field_name)
+	{
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$field_name
+		);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepareFieldNameFromJson($field_name)
+	{
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
+		}
+		return $field_name;
+	}
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepareFieldNamesFromJson(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array    $model_query_params
+	 * @param EEM_Base $model
+	 * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws EE_Error
+	 */
+	public static function prepareQueryParamsForRestApi(
+		array $model_query_params,
+		EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params,
+			$model_query_params,
+			$model,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param EEM_Base $model
+	 * @param string   $requested_version                   eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws EE_Error
+	 * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
+	 *                                                      (which would be really unusual)
+	 */
+	public static function prepareConditionsQueryParamsForRestApi(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
+				$model
+			);
+			if ($field instanceof EE_Model_Field_Base) {
+				// did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
+							$field,
+							$value,
+							$requested_version
+						);
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$query_param_value,
+						$requested_version
+					);
+				}
+				$query_param_for_models[ $query_param_key ] = $translated_value;
+			} else {
+				// so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+					$query_param_value,
+					$model,
+					$requested_version
+				);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param EEM_Base $model
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
+	{
+		// ok, now proceed with deducing which part is the model's name, and which is the field's name
+		// which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'_extract_column_name is empty when trying to extract column and table name from %s',
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			// the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
+		}
+		try {
+			return $model->field_settings_for($field_name, false);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Returns true if $data can be easily represented in JSON.
+	 * Basically, objects and resources can't be represented in JSON easily.
+	 *
+	 * @param mixed $data
+	 * @return bool
+	 */
+	protected static function isRepresentableInJson($data)
+	{
+		return is_scalar($data)
+			   || is_array($data)
+			   || is_null($data);
+	}
 }

core/libraries/rest_api/ModelVersionInfo.php

Indentation +436 added lines, -436 removed lines

@@ -21,440 +21,440 @@
 class ModelVersionInfo
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string) $requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array()
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string) $requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
+							$this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[ $version ] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[ $version ] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[ $model_name ]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[ $model_name ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[ $model->get_this_model_name() ])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array()
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[ $relation_name ] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

caffeinated/admin/extend/events/Extend_Events_Admin_Page.core.php

Indentation +1278 added lines, -1278 removed lines

@@ -16,1282 +16,1282 @@
 {
 
 
-    /**
-     * Extend_Events_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
-        }
-    }
-
-
-    /**
-     * Sets routes.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
-        // is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        // tkt_id?
-        $tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
-            ? $this->_req_data['TKT_ID']
-            : 0;
-        $new_page_routes = array(
-            'duplicate_event'          => array(
-                'func'       => '_duplicate_event',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'ticket_list_table'        => array(
-                'func'       => '_tickets_overview_list_table',
-                'capability' => 'ee_read_default_tickets',
-            ),
-            'trash_ticket'             => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'trash_tickets'            => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-                'args'       => array('trash' => true),
-            ),
-            'restore_ticket'           => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'restore_tickets'          => array(
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'delete_ticket'            => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $tkt_id,
-                'noheader'   => true,
-            ),
-            'delete_tickets'           => array(
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ),
-            'import_page'              => array(
-                'func'       => '_import_page',
-                'capability' => 'import',
-            ),
-            'import'                   => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'import_events'            => array(
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ),
-            'export_events'            => array(
-                'func'       => '_events_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'export_categories'        => array(
-                'func'       => '_categories_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'sample_export_file'       => array(
-                'func'       => '_sample_export_file',
-                'capability' => 'export',
-                'noheader'   => true,
-            ),
-            'update_template_settings' => array(
-                'func'       => '_update_template_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        // partial route/config override
-        $this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
-        $this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
-        // add tickets tab but only if there are more than one default ticket!
-        $tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        );
-        if ($tkt_count > 1) {
-            $new_page_config = array(
-                'ticket_list_table' => array(
-                    'nav'           => array(
-                        'label' => esc_html__('Default Tickets', 'event_espresso'),
-                        'order' => 60,
-                    ),
-                    'list_table'    => 'Tickets_List_Table',
-                    'require_nonce' => false,
-                ),
-            );
-        }
-        // template settings
-        $new_page_config['template_settings'] = array(
-            'nav'           => array(
-                'label' => esc_html__('Templates', 'event_espresso'),
-                'order' => 30,
-            ),
-            'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-            'help_tabs'     => array(
-                'general_settings_templates_help_tab' => array(
-                    'title'    => esc_html__('Templates', 'event_espresso'),
-                    'filename' => 'general_settings_templates',
-                ),
-            ),
-            'help_tour'     => array('Templates_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        // add filters and actions
-        // modifying _views
-        add_filter(
-            'FHEE_event_datetime_metabox_add_additional_date_time_template',
-            array($this, 'add_additional_datetime_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_clone_button_template',
-            array($this, 'add_datetime_clone_button'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_timezones_template',
-            array($this, 'datetime_timezones_template'),
-            10,
-            2
-        );
-        // filters for event list table
-        add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
-        add_filter(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            array($this, 'extra_list_table_actions'),
-            10,
-            2
-        );
-        // legend item
-        add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
-        add_action('admin_init', array($this, 'admin_init'));
-        // heartbeat stuff
-        add_filter('heartbeat_received', array($this, 'heartbeat_response'), 10, 2);
-    }
-
-
-    /**
-     * admin_init
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings = array_merge(
-            EE_Registry::$i18n_js_strings,
-            array(
-                'image_confirm'          => esc_html__(
-                    'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-                    'event_espresso'
-                ),
-                'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
-                'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
-                'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
-                'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
-                'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
-            )
-        );
-    }
-
-
-    /**
-     * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
-     * accordingly.
-     *
-     * @param array $response The existing heartbeat response array.
-     * @param array $data     The incoming data package.
-     * @return array  possibly appended response.
-     */
-    public function heartbeat_response($response, $data)
-    {
-        /**
-         * check whether count of tickets is approaching the potential
-         * limits for the server.
-         */
-        if (! empty($data['input_count'])) {
-            $response['max_input_vars_check'] = EE_Registry::instance()->CFG->environment->max_input_vars_limit_check(
-                $data['input_count']
-            );
-        }
-        return $response;
-    }
-
-
-    /**
-     * Add per page screen options to the default ticket list table view.
-     */
-    protected function _add_screen_options_ticket_list_table()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @param string $return
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $href = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'duplicate_event', 'EVT_ID' => $id),
-                $this->_admin_base_url
-            );
-            $title = esc_attr__('Duplicate Event', 'event_espresso');
-            $return .= '<a href="'
-                       . $href
-                       . '" title="'
-                       . $title
-                       . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
-                       . $title
-                       . '</a>';
-        }
-        return $return;
-    }
-
-
-    /**
-     * Set the list table views for the default ticket list table view.
-     */
-    public function _set_list_table_views_ticket_list_table()
-    {
-        $this->_views = array(
-            'all'     => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'trashed' => array(
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the event editor.
-     */
-    public function load_scripts_styles_edit()
-    {
-        wp_register_script(
-            'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
-            array('ee_admin_js', 'heartbeat'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-accounting');
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('event_editor_js');
-        wp_enqueue_script('ee-event-editor-heartbeat');
-    }
-
-
-    /**
-     * Returns template for the additional datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_additional_datetime_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for cloning a datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function add_datetime_clone_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for datetime timezones.
-     *
-     * @param $template
-     * @param $template_args
-     * @return mixed
-     * @throws DomainException
-     */
-    public function datetime_timezones_template($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Sets the views for the default list table view.
-     */
-    protected function _set_list_table_views_default()
-    {
-        parent::_set_list_table_views_default();
-        $new_views = array(
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => esc_html__('Today', 'event_espresso'),
-                'count'       => $this->total_events_today(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => $this->total_events_this_month(),
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        $this->_views = array_merge($this->_views, $new_views);
-    }
-
-
-    /**
-     * Returns the extra action links for the default list table view.
-     *
-     * @param array     $action_links
-     * @param \EE_Event $event
-     * @return array
-     * @throws EE_Error
-     */
-    public function extra_list_table_actions(array $action_links, \EE_Event $event)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports',
-            $event->ID()
-        )
-        ) {
-            $reports_query_args = array(
-                'action' => 'reports',
-                'EVT_ID' => $event->ID(),
-            );
-            $reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="'
-                              . $reports_link
-                              . '" title="'
-                              . esc_attr__('View Report', 'event_espresso')
-                              . '"><div class="dashicons dashicons-chart-bar"></div></a>'
-                              . "\n\t";
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            $action_links[] = EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                array('EVT_ID' => $event->ID())
-            );
-        }
-        return $action_links;
-    }
-
-
-    /**
-     * @param $items
-     * @return mixed
-     */
-    public function additional_legend_items($items)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports'
-        )
-        ) {
-            $items['reports'] = array(
-                'class' => 'dashicons dashicons-chart-bar',
-                'desc'  => esc_html__('Event Reports', 'event_espresso'),
-            );
-        }
-        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'])) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        return $items;
-    }
-
-
-    /**
-     * This is the callback method for the duplicate event route
-     * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
-     * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
-     * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
-     * After duplication the redirect is to the new event edit page.
-     *
-     * @return void
-     * @access protected
-     * @throws EE_Error If EE_Event is not available with given ID
-     */
-    protected function _duplicate_event()
-    {
-        // first make sure the ID for the event is in the request.
-        //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        if (! isset($this->_req_data['EVT_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to duplicate an event an Event ID is required.  None was given.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-            return;
-        }
-        // k we've got EVT_ID so let's use that to get the event we'll duplicate
-        $orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
-        if (! $orig_event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
-                    $this->_req_data['EVT_ID']
-                )
-            );
-        }
-        // k now let's clone the $orig_event before getting relations
-        $new_event = clone $orig_event;
-        // original datetimes
-        $orig_datetimes = $orig_event->get_many_related('Datetime');
-        // other original relations
-        $orig_ven = $orig_event->get_many_related('Venue');
-        // reset the ID and modify other details to make it clear this is a dupe
-        $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
-        $new_event->set('EVT_name', $new_name);
-        $new_event->set(
-            'EVT_slug',
-            wp_unique_post_slug(
-                sanitize_title($orig_event->name()),
-                0,
-                'publish',
-                'espresso_events',
-                0
-            )
-        );
-        $new_event->set('status', 'draft');
-        // duplicate discussion settings
-        $new_event->set('comment_status', $orig_event->get('comment_status'));
-        $new_event->set('ping_status', $orig_event->get('ping_status'));
-        // save the new event
-        $new_event->save();
-        // venues
-        foreach ($orig_ven as $ven) {
-            $new_event->_add_relation_to($ven, 'Venue');
-        }
-        $new_event->save();
-        // now we need to get the question group relations and handle that
-        // first primary question groups
-        $orig_primary_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 1))
-        );
-        if (! empty($orig_primary_qgs)) {
-            foreach ($orig_primary_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
-                }
-            }
-        }
-        // next additional attendee question groups
-        $orig_additional_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 0))
-        );
-        if (! empty($orig_additional_qgs)) {
-            foreach ($orig_additional_qgs as $id => $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
-                }
-            }
-        }
-
-        $new_event->save();
-
-        // k now that we have the new event saved we can loop through the datetimes and start adding relations.
-        $cloned_tickets = array();
-        foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
-                continue;
-            }
-            $new_dtt = clone $orig_dtt;
-            $orig_tkts = $orig_dtt->tickets();
-            // save new dtt then add to event
-            $new_dtt->set('DTT_ID', 0);
-            $new_dtt->set('DTT_sold', 0);
-            $new_dtt->set_reserved(0);
-            $new_dtt->save();
-            $new_event->_add_relation_to($new_dtt, 'Datetime');
-            $new_event->save();
-            // now let's get the ticket relations setup.
-            foreach ((array) $orig_tkts as $orig_tkt) {
-                // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_tkt instanceof EE_Ticket) {
-                    continue;
-                }
-                // is this ticket archived?  If it is then let's skip
-                if ($orig_tkt->get('TKT_deleted')) {
-                    continue;
-                }
-                // does this original ticket already exist in the clone_tickets cache?
-                //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
-                    $new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
-                } else {
-                    $new_tkt = clone $orig_tkt;
-                    // get relations on the $orig_tkt that we need to setup.
-                    $orig_prices = $orig_tkt->prices();
-                    $new_tkt->set('TKT_ID', 0);
-                    $new_tkt->set('TKT_sold', 0);
-                    $new_tkt->set('TKT_reserved', 0);
-                    $new_tkt->save(); // make sure new ticket has ID.
-                    // price relations on new ticket need to be setup.
-                    foreach ($orig_prices as $orig_price) {
-                        $new_price = clone $orig_price;
-                        $new_price->set('PRC_ID', 0);
-                        $new_price->save();
-                        $new_tkt->_add_relation_to($new_price, 'Price');
-                        $new_tkt->save();
-                    }
-
-                    do_action(
-                        'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
-                        $orig_tkt,
-                        $new_tkt,
-                        $orig_prices,
-                        $orig_event,
-                        $orig_dtt,
-                        $new_dtt
-                    );
-                }
-                // k now we can add the new ticket as a relation to the new datetime
-                // and make sure its added to our cached $cloned_tickets array
-                // for use with later datetimes that have the same ticket.
-                $new_dtt->_add_relation_to($new_tkt, 'Ticket');
-                $new_dtt->save();
-                $cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
-            }
-        }
-        // clone taxonomy information
-        $taxonomies_to_clone_with = apply_filters(
-            'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
-            array('espresso_event_categories', 'espresso_event_type', 'post_tag')
-        );
-        // get terms for original event (notice)
-        $orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
-        // loop through terms and add them to new event.
-        foreach ($orig_terms as $term) {
-            wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
-        }
-
-        // duplicate other core WP_Post items for this event.
-        // post thumbnail (feature image).
-        $feature_image_id = get_post_thumbnail_id($orig_event->ID());
-        if ($feature_image_id) {
-            update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
-        }
-
-        // duplicate page_template setting
-        $page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
-        if ($page_template) {
-            update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
-        }
-
-        do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
-        // now let's redirect to the edit page for this duplicated event if we have a new event id.
-        if ($new_event->ID()) {
-            $redirect_args = array(
-                'post'   => $new_event->ID(),
-                'action' => 'edit',
-            );
-            EE_Error::add_success(
-                esc_html__(
-                    'Event successfully duplicated.  Please review the details below and make any necessary edits',
-                    'event_espresso'
-                )
-            );
-        } else {
-            $redirect_args = array(
-                'action' => 'default',
-            );
-            EE_Error::add_error(
-                esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $redirect_args, true);
-    }
-
-
-    /**
-     * Generates output for the import page.
-     *
-     * @throws DomainException
-     */
-    protected function _import_page()
-    {
-        $title = esc_html__('Import', 'event_espresso');
-        $intro = esc_html__(
-            'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
-            'event_espresso'
-        );
-        $form_url = EVENTS_ADMIN_URL;
-        $action = 'import_events';
-        $type = 'csv';
-        $this->_template_args['form'] = EE_Import::instance()->upload_form(
-            $title,
-            $intro,
-            $form_url,
-            $action,
-            $type
-        );
-        $this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'sample_export_file'),
-            $this->_admin_base_url
-        );
-        $content = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['admin_page_content'] = $content;
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _import_events
-     * This handles displaying the screen and running imports for importing events.
-     *
-     * @return void
-     */
-    protected function _import_events()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        $success = EE_Import::instance()->import();
-        $this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
-    }
-
-
-    /**
-     * _events_export
-     * Will export all (or just the given event) to a Excel compatible file.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _events_export()
-    {
-        if (isset($this->_req_data['EVT_ID'])) {
-            $event_ids = $this->_req_data['EVT_ID'];
-        } elseif (isset($this->_req_data['EVT_IDs'])) {
-            $event_ids = $this->_req_data['EVT_IDs'];
-        } else {
-            $event_ids = null;
-        }
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export' => 'report',
-            'action' => 'all_event_data',
-            'EVT_ID' => $event_ids,
-        );
-        $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();
-        }
-    }
-
-
-    /**
-     * handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $new_request_args = array(
-            'export'       => 'report',
-            'action'       => 'categories',
-            'category_ids' => $this->_req_data['EVT_CAT_ID'],
-        );
-        $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 sample CSV file for importing
-     */
-    protected function _sample_export_file()
-    {
-        // require_once(EE_CLASSES . 'EE_Export.class.php');
-        EE_Export::instance()->export_sample();
-    }
-
-
-    /*************        Template Settings        *************/
-    /**
-     * Generates template settings page output
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        $this->_template_args = apply_filters(
-            'FHEE__General_Settings_Admin_Page__template_settings__template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_template_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating template settings.
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _update_template_settings()
-    {
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        EE_Registry::instance()->CFG->template_settings = apply_filters(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            EE_Registry::instance()->CFG->template_settings,
-            $this->_req_data
-        );
-        // update custom post type slugs and detect if we need to flush rewrite rules
-        $old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
-        EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
-            ? EE_Registry::instance()->CFG->core->event_cpt_slug
-            : EEH_URL::slugify($this->_req_data['event_cpt_slug'], 'events');
-        $what = 'Template Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->template_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-        }
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
-    }
-
-
-    /**
-     * _premium_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _premium_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            array($this, 'registration_options_meta_box'),
-            $this->page_slug,
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * override caf metabox
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = array(
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
-        );
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
-            'EVT_default_registration_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * wp_list_table_mods for caf
-     * ============================
-     */
-    /**
-     * hook into list table filters and provide filters for caffeinated list table
-     *
-     * @param  array $old_filters    any existing filters present
-     * @param  array $list_table_obj the list table object
-     * @return array                  new filters
-     */
-    public function list_table_filters($old_filters, $list_table_obj)
-    {
-        $filters = array();
-        // first month/year filters
-        $filters[] = $this->espresso_event_months_dropdown();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // active status dropdown
-        if ($status !== 'draft') {
-            $filters[] = $this->active_status_dropdown(
-                isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
-            );
-        }
-        // category filter
-        $filters[] = $this->category_dropdown();
-        return array_merge($old_filters, $filters);
-    }
-
-
-    /**
-     * espresso_event_months_dropdown
-     *
-     * @access public
-     * @return string                dropdown listing month/year selections for events.
-     */
-    public function espresso_event_months_dropdown()
-    {
-        // what we need to do is get all PRIMARY datetimes for all events to filter on.
-        // Note we need to include any other filters that are set!
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT']
-            : null;
-        // active status?
-        $active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
-        $cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
-        return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
-    }
-
-
-    /**
-     * returns a list of "active" statuses on the event
-     *
-     * @param  string $current_value whatever the current active status is
-     * @return string
-     */
-    public function active_status_dropdown($current_value = '')
-    {
-        $select_name = 'active_status';
-        $values = array(
-            'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
-            'active'   => esc_html__('Active', 'event_espresso'),
-            'upcoming' => esc_html__('Upcoming', 'event_espresso'),
-            'expired'  => esc_html__('Expired', 'event_espresso'),
-            'inactive' => esc_html__('Inactive', 'event_espresso'),
-        );
-        $id = 'id="espresso-active-status-dropdown-filter"';
-        $class = 'wide';
-        return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
-    }
-
-
-    /**
-     * output a dropdown of the categories for the category filter on the event admin list table
-     *
-     * @access  public
-     * @return string html
-     */
-    public function category_dropdown()
-    {
-        $cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
-        return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
-    }
-
-
-    /**
-     * get total number of events today
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_today()
-    {
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     * get total number of events this month
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_this_month()
-    {
-        // Dates
-        $this_year_r = date('Y');
-        $this_month_r = date('m');
-        $days_this_month = date('t');
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /** DEFAULT TICKETS STUFF **/
-
-    /**
-     * Output default tickets list table view.
-     */
-    public function _tickets_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $trashed
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
-    {
-        $orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
-        $order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
-        switch ($orderby) {
-            case 'TKT_name':
-                $orderby = array('TKT_name' => $order);
-                break;
-            case 'TKT_price':
-                $orderby = array('TKT_price' => $order);
-                break;
-            case 'TKT_uses':
-                $orderby = array('TKT_uses' => $order);
-                break;
-            case 'TKT_min':
-                $orderby = array('TKT_min' => $order);
-                break;
-            case 'TKT_max':
-                $orderby = array('TKT_max' => $order);
-                break;
-            case 'TKT_qty':
-                $orderby = array('TKT_qty' => $order);
-                break;
-        }
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where = array(
-            'TKT_is_default' => 1,
-            'TKT_deleted'    => $trashed,
-        );
-        $offset = ($current_page - 1) * $per_page;
-        $limit = array($offset, $per_page);
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'TKT_name'        => array('LIKE', $sstr),
-                'TKT_description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $_where,
-            'order_by' => $orderby,
-            'limit'    => $limit,
-            'group_by' => 'TKT_ID',
-        );
-        if ($count) {
-            return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
-        } else {
-            return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_ticket($trash = false)
-    {
-        $success = 1;
-        $TKT = EEM_Ticket::instance();
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        }
-        $action_desc = $trash ? 'moved to the trash' : 'restored';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => $trash ? '' : 'trashed',
-        );
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * Handles trashing default ticket.
-     */
-    protected function _delete_ticket()
-    {
-        $success = 1;
-        // checkboxes?
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
-                // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = absint($this->_req_data['TKT_ID']);
-            if (! $this->_delete_the_ticket($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = 'deleted';
-        $query_args = array(
-            'action' => 'ticket_list_table',
-            'status' => 'trashed',
-        );
-        // fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
-        if (EEM_Ticket::instance()->count_deleted_and_undeleted(
-            array(array('TKT_is_default' => 1)),
-            'TKT_ID',
-            true
-        )
-        ) {
-            $query_args = array();
-        }
-        $this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param int $TKT_ID
-     * @return bool|int
-     * @throws EE_Error
-     */
-    protected function _delete_the_ticket($TKT_ID)
-    {
-        $tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
-        $tkt->_remove_relations('Datetime');
-        // delete all related prices first
-        $tkt->delete_related_permanently('Price');
-        return $tkt->delete_permanently();
-    }
+	/**
+	 * Extend_Events_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+			define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
+			define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
+			define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+		}
+	}
+
+
+	/**
+	 * Sets routes.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+		// is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		// tkt_id?
+		$tkt_id = ! empty($this->_req_data['TKT_ID']) && ! is_array($this->_req_data['TKT_ID'])
+			? $this->_req_data['TKT_ID']
+			: 0;
+		$new_page_routes = array(
+			'duplicate_event'          => array(
+				'func'       => '_duplicate_event',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'ticket_list_table'        => array(
+				'func'       => '_tickets_overview_list_table',
+				'capability' => 'ee_read_default_tickets',
+			),
+			'trash_ticket'             => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'trash_tickets'            => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+				'args'       => array('trash' => true),
+			),
+			'restore_ticket'           => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'restore_tickets'          => array(
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'delete_ticket'            => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $tkt_id,
+				'noheader'   => true,
+			),
+			'delete_tickets'           => array(
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			),
+			'import_page'              => array(
+				'func'       => '_import_page',
+				'capability' => 'import',
+			),
+			'import'                   => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'import_events'            => array(
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			),
+			'export_events'            => array(
+				'func'       => '_events_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'export_categories'        => array(
+				'func'       => '_categories_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'sample_export_file'       => array(
+				'func'       => '_sample_export_file',
+				'capability' => 'export',
+				'noheader'   => true,
+			),
+			'update_template_settings' => array(
+				'func'       => '_update_template_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		// partial route/config override
+		$this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
+		$this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['qtips'][] = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['default']['list_table'] = 'Extend_Events_Admin_List_Table';
+		// add tickets tab but only if there are more than one default ticket!
+		$tkt_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		);
+		if ($tkt_count > 1) {
+			$new_page_config = array(
+				'ticket_list_table' => array(
+					'nav'           => array(
+						'label' => esc_html__('Default Tickets', 'event_espresso'),
+						'order' => 60,
+					),
+					'list_table'    => 'Tickets_List_Table',
+					'require_nonce' => false,
+				),
+			);
+		}
+		// template settings
+		$new_page_config['template_settings'] = array(
+			'nav'           => array(
+				'label' => esc_html__('Templates', 'event_espresso'),
+				'order' => 30,
+			),
+			'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+			'help_tabs'     => array(
+				'general_settings_templates_help_tab' => array(
+					'title'    => esc_html__('Templates', 'event_espresso'),
+					'filename' => 'general_settings_templates',
+				),
+			),
+			'help_tour'     => array('Templates_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		// add filters and actions
+		// modifying _views
+		add_filter(
+			'FHEE_event_datetime_metabox_add_additional_date_time_template',
+			array($this, 'add_additional_datetime_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_clone_button_template',
+			array($this, 'add_datetime_clone_button'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_timezones_template',
+			array($this, 'datetime_timezones_template'),
+			10,
+			2
+		);
+		// filters for event list table
+		add_filter('FHEE__Extend_Events_Admin_List_Table__filters', array($this, 'list_table_filters'), 10, 2);
+		add_filter(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			array($this, 'extra_list_table_actions'),
+			10,
+			2
+		);
+		// legend item
+		add_filter('FHEE__Events_Admin_Page___event_legend_items__items', array($this, 'additional_legend_items'));
+		add_action('admin_init', array($this, 'admin_init'));
+		// heartbeat stuff
+		add_filter('heartbeat_received', array($this, 'heartbeat_response'), 10, 2);
+	}
+
+
+	/**
+	 * admin_init
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings = array_merge(
+			EE_Registry::$i18n_js_strings,
+			array(
+				'image_confirm'          => esc_html__(
+					'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+					'event_espresso'
+				),
+				'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
+				'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
+				'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
+				'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
+				'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
+			)
+		);
+	}
+
+
+	/**
+	 * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
+	 * accordingly.
+	 *
+	 * @param array $response The existing heartbeat response array.
+	 * @param array $data     The incoming data package.
+	 * @return array  possibly appended response.
+	 */
+	public function heartbeat_response($response, $data)
+	{
+		/**
+		 * check whether count of tickets is approaching the potential
+		 * limits for the server.
+		 */
+		if (! empty($data['input_count'])) {
+			$response['max_input_vars_check'] = EE_Registry::instance()->CFG->environment->max_input_vars_limit_check(
+				$data['input_count']
+			);
+		}
+		return $response;
+	}
+
+
+	/**
+	 * Add per page screen options to the default ticket list table view.
+	 */
+	protected function _add_screen_options_ticket_list_table()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @param string $return
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		$return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$href = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'duplicate_event', 'EVT_ID' => $id),
+				$this->_admin_base_url
+			);
+			$title = esc_attr__('Duplicate Event', 'event_espresso');
+			$return .= '<a href="'
+					   . $href
+					   . '" title="'
+					   . $title
+					   . '" id="ee-duplicate-event-button" class="button button-small"  value="duplicate_event">'
+					   . $title
+					   . '</a>';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * Set the list table views for the default ticket list table view.
+	 */
+	public function _set_list_table_views_ticket_list_table()
+	{
+		$this->_views = array(
+			'all'     => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'trashed' => array(
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the event editor.
+	 */
+	public function load_scripts_styles_edit()
+	{
+		wp_register_script(
+			'ee-event-editor-heartbeat',
+			EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+			array('ee_admin_js', 'heartbeat'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-accounting');
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('event_editor_js');
+		wp_enqueue_script('ee-event-editor-heartbeat');
+	}
+
+
+	/**
+	 * Returns template for the additional datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_additional_datetime_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for cloning a datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function add_datetime_clone_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for datetime timezones.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function datetime_timezones_template($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Sets the views for the default list table view.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		parent::_set_list_table_views_default();
+		$new_views = array(
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => esc_html__('Today', 'event_espresso'),
+				'count'       => $this->total_events_today(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => $this->total_events_this_month(),
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		$this->_views = array_merge($this->_views, $new_views);
+	}
+
+
+	/**
+	 * Returns the extra action links for the default list table view.
+	 *
+	 * @param array     $action_links
+	 * @param \EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function extra_list_table_actions(array $action_links, \EE_Event $event)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports',
+			$event->ID()
+		)
+		) {
+			$reports_query_args = array(
+				'action' => 'reports',
+				'EVT_ID' => $event->ID(),
+			);
+			$reports_link = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="'
+							  . $reports_link
+							  . '" title="'
+							  . esc_attr__('View Report', 'event_espresso')
+							  . '"><div class="dashicons dashicons-chart-bar"></div></a>'
+							  . "\n\t";
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			$action_links[] = EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				array('EVT_ID' => $event->ID())
+			);
+		}
+		return $action_links;
+	}
+
+
+	/**
+	 * @param $items
+	 * @return mixed
+	 */
+	public function additional_legend_items($items)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports'
+		)
+		) {
+			$items['reports'] = array(
+				'class' => 'dashicons dashicons-chart-bar',
+				'desc'  => esc_html__('Event Reports', 'event_espresso'),
+			);
+		}
+		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'])) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		return $items;
+	}
+
+
+	/**
+	 * This is the callback method for the duplicate event route
+	 * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
+	 * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
+	 * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
+	 * After duplication the redirect is to the new event edit page.
+	 *
+	 * @return void
+	 * @access protected
+	 * @throws EE_Error If EE_Event is not available with given ID
+	 */
+	protected function _duplicate_event()
+	{
+		// first make sure the ID for the event is in the request.
+		//  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
+		if (! isset($this->_req_data['EVT_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to duplicate an event an Event ID is required.  None was given.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+			return;
+		}
+		// k we've got EVT_ID so let's use that to get the event we'll duplicate
+		$orig_event = EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']);
+		if (! $orig_event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
+					$this->_req_data['EVT_ID']
+				)
+			);
+		}
+		// k now let's clone the $orig_event before getting relations
+		$new_event = clone $orig_event;
+		// original datetimes
+		$orig_datetimes = $orig_event->get_many_related('Datetime');
+		// other original relations
+		$orig_ven = $orig_event->get_many_related('Venue');
+		// reset the ID and modify other details to make it clear this is a dupe
+		$new_event->set('EVT_ID', 0);
+		$new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+		$new_event->set('EVT_name', $new_name);
+		$new_event->set(
+			'EVT_slug',
+			wp_unique_post_slug(
+				sanitize_title($orig_event->name()),
+				0,
+				'publish',
+				'espresso_events',
+				0
+			)
+		);
+		$new_event->set('status', 'draft');
+		// duplicate discussion settings
+		$new_event->set('comment_status', $orig_event->get('comment_status'));
+		$new_event->set('ping_status', $orig_event->get('ping_status'));
+		// save the new event
+		$new_event->save();
+		// venues
+		foreach ($orig_ven as $ven) {
+			$new_event->_add_relation_to($ven, 'Venue');
+		}
+		$new_event->save();
+		// now we need to get the question group relations and handle that
+		// first primary question groups
+		$orig_primary_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 1))
+		);
+		if (! empty($orig_primary_qgs)) {
+			foreach ($orig_primary_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 1));
+				}
+			}
+		}
+		// next additional attendee question groups
+		$orig_additional_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 0))
+		);
+		if (! empty($orig_additional_qgs)) {
+			foreach ($orig_additional_qgs as $id => $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', array('EQG_primary' => 0));
+				}
+			}
+		}
+
+		$new_event->save();
+
+		// k now that we have the new event saved we can loop through the datetimes and start adding relations.
+		$cloned_tickets = array();
+		foreach ($orig_datetimes as $orig_dtt) {
+			if (! $orig_dtt instanceof EE_Datetime) {
+				continue;
+			}
+			$new_dtt = clone $orig_dtt;
+			$orig_tkts = $orig_dtt->tickets();
+			// save new dtt then add to event
+			$new_dtt->set('DTT_ID', 0);
+			$new_dtt->set('DTT_sold', 0);
+			$new_dtt->set_reserved(0);
+			$new_dtt->save();
+			$new_event->_add_relation_to($new_dtt, 'Datetime');
+			$new_event->save();
+			// now let's get the ticket relations setup.
+			foreach ((array) $orig_tkts as $orig_tkt) {
+				// it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
+				if (! $orig_tkt instanceof EE_Ticket) {
+					continue;
+				}
+				// is this ticket archived?  If it is then let's skip
+				if ($orig_tkt->get('TKT_deleted')) {
+					continue;
+				}
+				// does this original ticket already exist in the clone_tickets cache?
+				//  If so we'll just use the new ticket from it.
+				if (isset($cloned_tickets[ $orig_tkt->ID() ])) {
+					$new_tkt = $cloned_tickets[ $orig_tkt->ID() ];
+				} else {
+					$new_tkt = clone $orig_tkt;
+					// get relations on the $orig_tkt that we need to setup.
+					$orig_prices = $orig_tkt->prices();
+					$new_tkt->set('TKT_ID', 0);
+					$new_tkt->set('TKT_sold', 0);
+					$new_tkt->set('TKT_reserved', 0);
+					$new_tkt->save(); // make sure new ticket has ID.
+					// price relations on new ticket need to be setup.
+					foreach ($orig_prices as $orig_price) {
+						$new_price = clone $orig_price;
+						$new_price->set('PRC_ID', 0);
+						$new_price->save();
+						$new_tkt->_add_relation_to($new_price, 'Price');
+						$new_tkt->save();
+					}
+
+					do_action(
+						'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
+						$orig_tkt,
+						$new_tkt,
+						$orig_prices,
+						$orig_event,
+						$orig_dtt,
+						$new_dtt
+					);
+				}
+				// k now we can add the new ticket as a relation to the new datetime
+				// and make sure its added to our cached $cloned_tickets array
+				// for use with later datetimes that have the same ticket.
+				$new_dtt->_add_relation_to($new_tkt, 'Ticket');
+				$new_dtt->save();
+				$cloned_tickets[ $orig_tkt->ID() ] = $new_tkt;
+			}
+		}
+		// clone taxonomy information
+		$taxonomies_to_clone_with = apply_filters(
+			'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
+			array('espresso_event_categories', 'espresso_event_type', 'post_tag')
+		);
+		// get terms for original event (notice)
+		$orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
+		// loop through terms and add them to new event.
+		foreach ($orig_terms as $term) {
+			wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
+		}
+
+		// duplicate other core WP_Post items for this event.
+		// post thumbnail (feature image).
+		$feature_image_id = get_post_thumbnail_id($orig_event->ID());
+		if ($feature_image_id) {
+			update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
+		}
+
+		// duplicate page_template setting
+		$page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
+		if ($page_template) {
+			update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
+		}
+
+		do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
+		// now let's redirect to the edit page for this duplicated event if we have a new event id.
+		if ($new_event->ID()) {
+			$redirect_args = array(
+				'post'   => $new_event->ID(),
+				'action' => 'edit',
+			);
+			EE_Error::add_success(
+				esc_html__(
+					'Event successfully duplicated.  Please review the details below and make any necessary edits',
+					'event_espresso'
+				)
+			);
+		} else {
+			$redirect_args = array(
+				'action' => 'default',
+			);
+			EE_Error::add_error(
+				esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $redirect_args, true);
+	}
+
+
+	/**
+	 * Generates output for the import page.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _import_page()
+	{
+		$title = esc_html__('Import', 'event_espresso');
+		$intro = esc_html__(
+			'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
+			'event_espresso'
+		);
+		$form_url = EVENTS_ADMIN_URL;
+		$action = 'import_events';
+		$type = 'csv';
+		$this->_template_args['form'] = EE_Import::instance()->upload_form(
+			$title,
+			$intro,
+			$form_url,
+			$action,
+			$type
+		);
+		$this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'sample_export_file'),
+			$this->_admin_base_url
+		);
+		$content = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['admin_page_content'] = $content;
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _import_events
+	 * This handles displaying the screen and running imports for importing events.
+	 *
+	 * @return void
+	 */
+	protected function _import_events()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		$success = EE_Import::instance()->import();
+		$this->_redirect_after_action($success, 'Import File', 'ran', array('action' => 'import_page'), true);
+	}
+
+
+	/**
+	 * _events_export
+	 * Will export all (or just the given event) to a Excel compatible file.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _events_export()
+	{
+		if (isset($this->_req_data['EVT_ID'])) {
+			$event_ids = $this->_req_data['EVT_ID'];
+		} elseif (isset($this->_req_data['EVT_IDs'])) {
+			$event_ids = $this->_req_data['EVT_IDs'];
+		} else {
+			$event_ids = null;
+		}
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export' => 'report',
+			'action' => 'all_event_data',
+			'EVT_ID' => $event_ids,
+		);
+		$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();
+		}
+	}
+
+
+	/**
+	 * handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$new_request_args = array(
+			'export'       => 'report',
+			'action'       => 'categories',
+			'category_ids' => $this->_req_data['EVT_CAT_ID'],
+		);
+		$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 sample CSV file for importing
+	 */
+	protected function _sample_export_file()
+	{
+		// require_once(EE_CLASSES . 'EE_Export.class.php');
+		EE_Export::instance()->export_sample();
+	}
+
+
+	/*************        Template Settings        *************/
+	/**
+	 * Generates template settings page output
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _template_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		$this->_template_args = apply_filters(
+			'FHEE__General_Settings_Admin_Page__template_settings__template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_template_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating template settings.
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _update_template_settings()
+	{
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		EE_Registry::instance()->CFG->template_settings = apply_filters(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			EE_Registry::instance()->CFG->template_settings,
+			$this->_req_data
+		);
+		// update custom post type slugs and detect if we need to flush rewrite rules
+		$old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
+		EE_Registry::instance()->CFG->core->event_cpt_slug = empty($this->_req_data['event_cpt_slug'])
+			? EE_Registry::instance()->CFG->core->event_cpt_slug
+			: EEH_URL::slugify($this->_req_data['event_cpt_slug'], 'events');
+		$what = 'Template Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->template_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+		}
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'template_settings'));
+	}
+
+
+	/**
+	 * _premium_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _premium_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			array($this, 'registration_options_meta_box'),
+			$this->page_slug,
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * override caf metabox
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = array(
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
+		);
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
+			'EVT_default_registration_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * wp_list_table_mods for caf
+	 * ============================
+	 */
+	/**
+	 * hook into list table filters and provide filters for caffeinated list table
+	 *
+	 * @param  array $old_filters    any existing filters present
+	 * @param  array $list_table_obj the list table object
+	 * @return array                  new filters
+	 */
+	public function list_table_filters($old_filters, $list_table_obj)
+	{
+		$filters = array();
+		// first month/year filters
+		$filters[] = $this->espresso_event_months_dropdown();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// active status dropdown
+		if ($status !== 'draft') {
+			$filters[] = $this->active_status_dropdown(
+				isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : ''
+			);
+		}
+		// category filter
+		$filters[] = $this->category_dropdown();
+		return array_merge($old_filters, $filters);
+	}
+
+
+	/**
+	 * espresso_event_months_dropdown
+	 *
+	 * @access public
+	 * @return string                dropdown listing month/year selections for events.
+	 */
+	public function espresso_event_months_dropdown()
+	{
+		// what we need to do is get all PRIMARY datetimes for all events to filter on.
+		// Note we need to include any other filters that are set!
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT']
+			: null;
+		// active status?
+		$active_status = isset($this->_req_data['active_status']) ? $this->_req_data['active_status'] : null;
+		$cur_date = isset($this->_req_data['month_range']) ? $this->_req_data['month_range'] : '';
+		return EEH_Form_Fields::generate_event_months_dropdown($cur_date, $status, $category, $active_status);
+	}
+
+
+	/**
+	 * returns a list of "active" statuses on the event
+	 *
+	 * @param  string $current_value whatever the current active status is
+	 * @return string
+	 */
+	public function active_status_dropdown($current_value = '')
+	{
+		$select_name = 'active_status';
+		$values = array(
+			'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
+			'active'   => esc_html__('Active', 'event_espresso'),
+			'upcoming' => esc_html__('Upcoming', 'event_espresso'),
+			'expired'  => esc_html__('Expired', 'event_espresso'),
+			'inactive' => esc_html__('Inactive', 'event_espresso'),
+		);
+		$id = 'id="espresso-active-status-dropdown-filter"';
+		$class = 'wide';
+		return EEH_Form_Fields::select_input($select_name, $values, $current_value, $id, $class);
+	}
+
+
+	/**
+	 * output a dropdown of the categories for the category filter on the event admin list table
+	 *
+	 * @access  public
+	 * @return string html
+	 */
+	public function category_dropdown()
+	{
+		$cur_cat = isset($this->_req_data['EVT_CAT']) ? $this->_req_data['EVT_CAT'] : -1;
+		return EEH_Form_Fields::generate_event_category_dropdown($cur_cat);
+	}
+
+
+	/**
+	 * get total number of events today
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_today()
+	{
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 * get total number of events this month
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_this_month()
+	{
+		// Dates
+		$this_year_r = date('Y');
+		$this_month_r = date('m');
+		$days_this_month = date('t');
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-01 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'Datetime.DTT_EVT_start' => array('BETWEEN', array($start, $end)),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/** DEFAULT TICKETS STUFF **/
+
+	/**
+	 * Output default tickets list table view.
+	 */
+	public function _tickets_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $trashed
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
+	{
+		$orderby = empty($this->_req_data['orderby']) ? 'TKT_name' : $this->_req_data['orderby'];
+		$order = empty($this->_req_data['order']) ? 'ASC' : $this->_req_data['order'];
+		switch ($orderby) {
+			case 'TKT_name':
+				$orderby = array('TKT_name' => $order);
+				break;
+			case 'TKT_price':
+				$orderby = array('TKT_price' => $order);
+				break;
+			case 'TKT_uses':
+				$orderby = array('TKT_uses' => $order);
+				break;
+			case 'TKT_min':
+				$orderby = array('TKT_min' => $order);
+				break;
+			case 'TKT_max':
+				$orderby = array('TKT_max' => $order);
+				break;
+			case 'TKT_qty':
+				$orderby = array('TKT_qty' => $order);
+				break;
+		}
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where = array(
+			'TKT_is_default' => 1,
+			'TKT_deleted'    => $trashed,
+		);
+		$offset = ($current_page - 1) * $per_page;
+		$limit = array($offset, $per_page);
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'TKT_name'        => array('LIKE', $sstr),
+				'TKT_description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$_where,
+			'order_by' => $orderby,
+			'limit'    => $limit,
+			'group_by' => 'TKT_ID',
+		);
+		if ($count) {
+			return EEM_Ticket::instance()->count_deleted_and_undeleted(array($_where));
+		} else {
+			return EEM_Ticket::instance()->get_all_deleted_and_undeleted($query_params);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_ticket($trash = false)
+	{
+		$success = 1;
+		$TKT = EEM_Ticket::instance();
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				if ($trash) {
+					if (! $TKT->delete_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				} else {
+					if (! $TKT->restore_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if ($trash) {
+				if (! $TKT->delete_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			} else {
+				if (! $TKT->restore_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		}
+		$action_desc = $trash ? 'moved to the trash' : 'restored';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => $trash ? '' : 'trashed',
+		);
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * Handles trashing default ticket.
+	 */
+	protected function _delete_ticket()
+	{
+		$success = 1;
+		// checkboxes?
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			while (list($TKT_ID, $value) = each($this->_req_data['checkbox'])) {
+				// delete
+				if (! $this->_delete_the_ticket($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = absint($this->_req_data['TKT_ID']);
+			if (! $this->_delete_the_ticket($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = 'deleted';
+		$query_args = array(
+			'action' => 'ticket_list_table',
+			'status' => 'trashed',
+		);
+		// fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
+		if (EEM_Ticket::instance()->count_deleted_and_undeleted(
+			array(array('TKT_is_default' => 1)),
+			'TKT_ID',
+			true
+		)
+		) {
+			$query_args = array();
+		}
+		$this->_redirect_after_action($success, 'Tickets', $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param int $TKT_ID
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	protected function _delete_the_ticket($TKT_ID)
+	{
+		$tkt = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
+		$tkt->_remove_relations('Datetime');
+		// delete all related prices first
+		$tkt->delete_related_permanently('Price');
+		return $tkt->delete_permanently();
+	}
 }