eventespresso / event-espresso-core

core/db_classes/EE_Import.class.php

Doc Comments +3 added lines, -6 removed lines

@@ -93,7 +93,6 @@ 
      *
      * @param string $title     - heading for the form
      * @param string $intro     - additional text explaing what to do
-     * @param string $page      - EE Admin page to direct form to - in the form "espresso_{pageslug}"
      * @param string $action    - EE Admin page route array "action" that form will direct to
      * @param string $type      - type of file to import
      *                          @ return    string
@@ -136,7 +135,7 @@ 
     /**
      * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
      * @access public
-     * @return boolean success
+     * @return boolean|null success
      * @throws EE_Error
      */
     public function import()
@@ -311,9 +310,7 @@ 
      * @access public
      * @param array $csv_data_array - the array containing the csv data produced from
      *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws \EE_Error
      */
     public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
@@ -776,7 +773,7 @@ 
      * @param type   $object_id
      * @param string $model_name
      * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
+     * @param boolean   $export_from_site_a_to_b
      * @return int
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)

Indentation +975 added lines, -975 removed lines

@@ -14,97 +14,97 @@ 
 class EE_Import implements ResettableInterface
 {
 
-    const do_insert  = 'insert';
-
-    const do_update  = 'update';
-
-    const do_nothing = 'nothing';
-
-
-    // instance of the EE_Import object
-    private static $_instance  = null;
-
-    private static $_csv_array = [];
-
-    /**
-     *
-     * @var array of model names
-     */
-    private static $_model_list          = [];
-
-    private static $_columns_to_save     = [];
-
-    protected $_total_inserts       = 0;
-
-    protected $_total_updates       = 0;
-
-    protected $_total_insert_errors = 0;
-
-    protected $_total_update_errors = 0;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        $this->_total_inserts       = 0;
-        $this->_total_updates       = 0;
-        $this->_total_insert_errors = 0;
-        $this->_total_update_errors = 0;
-    }
-
-
-    /**
-     *    @ singleton method used to instantiate class object
-     *    @ access public
-     *
-     * @return EE_Import
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the importer
-     *
-     * @return EE_Import
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *    @ generates HTML for a file upload input and form
-     *    @ access    public
-     *
-     * @param string $title     - heading for the form
-     * @param string $intro     - additional text explaing what to do
-     * @param string $page      - EE Admin page to direct form to - in the form "espresso_{pageslug}"
-     * @param string $action    - EE Admin page route array "action" that form will direct to
-     * @param string $type      - type of file to import
-     *                          @ return    string
-     */
-    public function upload_form($title, $intro, $form_url, $action, $type)
-    {
-
-        $form_url = EE_Admin_Page::add_query_args_and_nonce(['action' => $action], $form_url);
-
-        ob_start();
-        ?>
+	const do_insert  = 'insert';
+
+	const do_update  = 'update';
+
+	const do_nothing = 'nothing';
+
+
+	// instance of the EE_Import object
+	private static $_instance  = null;
+
+	private static $_csv_array = [];
+
+	/**
+	 *
+	 * @var array of model names
+	 */
+	private static $_model_list          = [];
+
+	private static $_columns_to_save     = [];
+
+	protected $_total_inserts       = 0;
+
+	protected $_total_updates       = 0;
+
+	protected $_total_insert_errors = 0;
+
+	protected $_total_update_errors = 0;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		$this->_total_inserts       = 0;
+		$this->_total_updates       = 0;
+		$this->_total_insert_errors = 0;
+		$this->_total_update_errors = 0;
+	}
+
+
+	/**
+	 *    @ singleton method used to instantiate class object
+	 *    @ access public
+	 *
+	 * @return EE_Import
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the importer
+	 *
+	 * @return EE_Import
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *    @ generates HTML for a file upload input and form
+	 *    @ access    public
+	 *
+	 * @param string $title     - heading for the form
+	 * @param string $intro     - additional text explaing what to do
+	 * @param string $page      - EE Admin page to direct form to - in the form "espresso_{pageslug}"
+	 * @param string $action    - EE Admin page route array "action" that form will direct to
+	 * @param string $type      - type of file to import
+	 *                          @ return    string
+	 */
+	public function upload_form($title, $intro, $form_url, $action, $type)
+	{
+
+		$form_url = EE_Admin_Page::add_query_args_and_nonce(['action' => $action], $form_url);
+
+		ob_start();
+		?>
         <div class="ee-upload-form-dv">
             <h3><?php echo $title; ?></h3>
             <p><?php echo $intro; ?></p>
@@ -120,893 +120,893 @@ 
                 <b><?php _e('Attention', 'event_espresso'); ?></b><br/>
                 <?php echo sprintf(__('Accepts .%s file types only.', 'event_espresso'), $type); ?>
                 <?php echo __(
-                    'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
-                    'event_espresso'
-                ); ?>
+					'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
+					'event_espresso'
+				); ?>
             </p>
 
         </div>
 
         <?php
-        $uploader = ob_get_clean();
-        return $uploader;
-    }
-
-
-    /**
-     * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
-     * @access public
-     * @return boolean success
-     * @throws EE_Error
-     */
-    public function import()
-    {
-
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-
-        if (isset($_REQUEST['import'])) {
-            if (isset($_POST['csv_submitted'])) {
-                switch ($_FILES['file']['error'][0]) {
-                    case UPLOAD_ERR_OK:
-                        $error_msg = false;
-                        break;
-                    case UPLOAD_ERR_INI_SIZE:
-                        $error_msg = __(
-                            "'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_FORM_SIZE:
-                        $error_msg = __(
-                            'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_PARTIAL:
-                        $error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_FILE:
-                        $error_msg = __('No file was uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_TMP_DIR:
-                        $error_msg = __('Missing a temporary folder.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_CANT_WRITE:
-                        $error_msg = __('Failed to write file to disk.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_EXTENSION:
-                        $error_msg = __('File upload stopped by extension.', "event_espresso");
-                        break;
-                    default:
-                        $error_msg = __(
-                            'An unknown error occurred and the file could not be uploaded',
-                            "event_espresso"
-                        );
-                        break;
-                }
-
-                if (! $error_msg) {
-                    $filename  = $_FILES['file']['name'][0];
-                    $file_ext  = substr(strrchr($filename, '.'), 1);
-                    $file_type = $_FILES['file']['type'][0];
-                    $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize  = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
-
-                    if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
-                        if ($filesize < $max_upload || true) {
-                            $wp_upload_dir = str_replace(['\\', '/'], '/', wp_upload_dir());
-                            $path_to_file  = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
-
-                            if (move_uploaded_file($temp_file, $path_to_file)) {
-                                // convert csv to array
-                                $this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
-
-                                // was data successfully stored in an array?
-                                if (is_array($this->csv_array)) {
-                                    $import_what           = str_replace('csv_import_', '', $_REQUEST['action']);
-                                    $import_what           = str_replace('_', ' ', ucwords($import_what));
-                                    $processed_data        = $this->csv_array;
-                                    $this->columns_to_save = false;
-
-                                    // if any imports require funcky processing, we'll catch them in the switch
-                                    switch ($_REQUEST['action']) {
-                                        case "import_events":
-                                        case "event_list":
-                                            $import_what = 'Event Details';
-                                            break;
-
-                                        case 'groupon_import_csv':
-                                            $import_what    = 'Groupon Codes';
-                                            $processed_data = $this->process_groupon_codes();
-                                            break;
-                                    }
-                                    // save processed codes to db
-                                    if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
-                                        return true;
-                                    }
-                                } else {
-                                    // no array? must be an error
-                                    EE_Error::add_error(
-                                        sprintf(__("No file seems to have been uploaded", "event_espresso")),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    return false;
-                                }
-                            } else {
-                                EE_Error::add_error(
-                                    sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                        } else {
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        "%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
-                                        "event_espresso"
-                                    ),
-                                    $filename,
-                                    $max_upload
-                                ),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                            return false;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                }
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
-     *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
-     *    next level being numeric indexes adn each value representing a model object, and the last layer down
-     *    being keys of model fields and their proposed values.
-     *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
-     *    If the CSV data says (in the metadata row) that it's from the SAME database,
-     *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
-     *    IDs DON'T exist in the database, they're treated as temporary IDs,
-     *    which can used elsewhere to refer to the same object. Once an item
-     *    with a temporary ID gets inserted, we record its mapping from temporary
-     *    ID to real ID, and use the real ID in place of the temporary ID
-     *    when that temporary ID was used as a foreign key.
-     *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
-     *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
-     *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
-     *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
-     *    An important exception are non-auto-increment primary keys. If one entry in the
-     *    CSV file has the same ID as one in the DB, we assume they are meant to be
-     *    the same item, and instead update the item in the DB with that same ID.
-     *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
-     *    time you import a CSV from a different site, we remember their mappings, and
-     * will try to update the item in the DB instead of inserting another item (eg
-     * if we previously imported an event with temporary ID 1, and then it got a
-     * real ID of 123, we remember that. So the next time we import an event with
-     * temporary ID, from the same site, we know that it's real ID is 123, and will
-     * update that event, instead of adding a new event).
-     *
-     * @access public
-     * @param array $csv_data_array - the array containing the csv data produced from
-     *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
-    {
-        $success = false;
-        $error   = false;
-        // whther to treat this import as if it's data froma different database or not
-        // ie, if it IS from a different database, ignore foreign keys whihf
-        $export_from_site_a_to_b = true;
-        // first level of array is not table information but a table name was passed to the function
-        // array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
-        if ($model_name) {
-            $csv_data_array = [$csv_data_array];
-        }
-        // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
-        $old_site_url = 'none-specified';
-        // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
-            // ok so its metadata, dont try to save it to ehte db obviously...
-            if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from the same database, so attempting to update data",
-                            "event_espresso"
-                        )
-                    )
-                );
-                $export_from_site_a_to_b = false;
-            } else {
-                $old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
-                            "event_espresso"
-                        ),
-                        $old_site_url,
-                        site_url()
-                    )
-                );
-            };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
-        }
-        /**
-         * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
-         * the value will be the newly-inserted ID.
-         * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
-         */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), []);
-        if ($old_db_to_new_db_mapping) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        "We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
-                        "event_espresso"
-                    ),
-                    $old_site_url,
-                    site_url()
-                )
-            );
-        }
-        $old_db_to_new_db_mapping = $this->save_data_rows_to_db(
-            $csv_data_array,
-            $export_from_site_a_to_b,
-            $old_db_to_new_db_mapping
-        );
-
-        // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
-
-        if ($this->_total_updates > 0) {
-            EE_Error::add_success(
-                sprintf(
-                    __("%s existing records in the database were updated.", "event_espresso"),
-                    $this->_total_updates
-                )
-            );
-            $success = true;
-        }
-        if ($this->_total_inserts > 0) {
-            EE_Error::add_success(
-                sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
-            );
-            $success = true;
-        }
-
-        if ($this->_total_update_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_update_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-        if ($this->_total_insert_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_insert_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-
-        // lastly, we need to update the datetime and ticket sold amounts
-        // as those may have been affected by this
-        EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
-
-        // if there was at least one success and absolutely no errors
-        if ($success && ! $error) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Processes the array of data, given the knowledge that it's from the same database or a different one,
-     * and the mapping from temporary IDs to real IDs.
-     * If the data is from a different database, we treat the primary keys and their corresponding
-     * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
-     * in the real target database. As items are inserted, their temporary primary keys
-     * are mapped to the real IDs in the target database. Also, before doing any update or
-     * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
-     * An exception: string primary keys are treated as real IDs, or else we'd need to
-     * dynamically generate new string primary keys which would be very awkward for the country table etc.
-     * Also, models with no primary key are strange too. We combine use their primary key INDEX (a
-     * combination of fields) to create a unique string identifying the row and store
-     * those in the mapping.
-     *
-     * If the data is from the same database, we usually treat primary keys as real IDs.
-     * An exception is if there is nothing in the database for that ID. If that's the case,
-     * we need to insert a new row for that ID, and then map from the non-existent ID
-     * to the newly-inserted real ID.
-     *
-     * @param array   $csv_data_array
-     * @param boolean $export_from_site_a_to_b
-     * @param array   $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save_data_rows_to_db(
-        array $csv_data_array,
-        $export_from_site_a_to_b,
-        array $old_db_to_new_db_mapping
-    ) {
-        foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
-            // now check that assumption was correct. If
-            if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
-                $model_name = $model_name_in_csv_data;
-            } else {
-                // no table info in the array and no table name passed to the function?? FAIL
-                EE_Error::add_error(
-                    __(
-                        'No table information was specified and/or found, therefore the import could not be completed',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return [];
-            }
-            /* @var $model EEM_Base */
-            $model = EE_Registry::instance()->load_model($model_name);
-
-            // so without further ado, scanning all the data provided for primary keys and their initial values
-            foreach ($model_data_from_import as $model_object_data) {
-                // before we do ANYTHING, make sure the csv row wasn't just completely blank
-                $row_is_completely_empty = true;
-                foreach ($model_object_data as $field) {
-                    if ($field) {
-                        $row_is_completely_empty = false;
-                    }
-                }
-                if ($row_is_completely_empty) {
-                    continue;
-                }
-                // find the PK in the row of data (or a combined key if
-                // there is no primary key)
-                if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    $id_in_csv = $model->get_index_primary_key_string($model_object_data);
-                }
-
-
-                $model_object_data = $this->_replace_temp_ids_with_mappings(
-                    $model_object_data,
-                    $model,
-                    $old_db_to_new_db_mapping,
-                    $export_from_site_a_to_b
-                );
-                // now we need to decide if we're going to add a new model object given the $model_object_data,
-                // or just update.
-                if ($export_from_site_a_to_b) {
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {// this is just a re-import
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model
-                    );
-                }
-                if ($what_to_do == self::do_nothing) {
-                    continue;
-                }
-
-                // double-check we actually want to insert, if that's what we're planning
-                // based on whether this item would be unique in the DB or not
-                if ($what_to_do == self::do_insert) {
-                    // we're supposed to be inserting. But wait, will this thing
-                    // be acceptable if inserted?
-                    $conflicting = $model->get_one_conflicting($model_object_data, false);
-                    if ($conflicting) {
-                        // ok, this item would conflict if inserted. Just update the item that it conflicts with.
-                        $what_to_do = self::do_update;
-                        // and if this model has a primary key, remember its mapping
-                        if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ]       = $conflicting->ID();
-                        } else {
-                            // we want to update this conflicting item, instead of inserting a conflicting item
-                            // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
-                            // for the WHERE conditions in the update). At the time of this comment, there were no models like this
-                            foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
-                                    $key_field->get_name()
-                                );
-                            }
-                        }
-                    }
-                }
-                if ($what_to_do == self::do_insert) {
-                    $old_db_to_new_db_mapping = $this->_insert_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } elseif ($what_to_do == self::do_update) {
-                    $old_db_to_new_db_mapping = $this->_update_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
-                                'event_espresso'
-                            ),
-                            $what_to_do
-                        )
-                    );
-                }
-            }
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Decides whether or not to insert, given that this data is from another database.
-     * So, if the primary key of this $model_object_data already exists in the database,
-     * it's just a coincidence and we should still insert. The only time we should
-     * update is when we know what it maps to, or there's something that would
-     * conflict (and we should instead just update that conflicting thing)
-     *
-     * @param string   $id_in_csv
-     * @param array    $model_object_data        by reference so it can be modified
-     * @param EEM_Base $model
-     * @param array    $old_db_to_new_db_mapping by reference so it can be modified
-     * @return string one of the consts on this class that starts with do_*
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
-        $id_in_csv,
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping
-    ) {
-        $model_name = $model->get_this_model_name();
-        // if it's a site-to-site export-and-import, see if this modelobject's id
-        // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-
-    /**
-     * If this thing basically already exists in the database, we want to update it;
-     * otherwise insert it (ie, someone tweaked the CSV file, or the item was
-     * deleted in the database so it should be re-inserted)
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
-        $id_in_csv,
-        $model_object_data,
-        $model
-    ) {
-        // in this case, check if this thing ACTUALLY exists in the database
-        if ($model->get_one_conflicting($model_object_data)) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-
-    /**
-     * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
-     * with their mapped real IDs. Eg, if importing from site A to B, the mapping
-     * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
-     * So this function searches for any event temp Ids called "my_event_id" and
-     * replaces them with 123.
-     * Also, if there is no temp ID for the INT foreign keys from another database,
-     * replaces them with 0 or the field's default.
-     *
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @param boolean  $export_from_site_a_to_b
-     * @return array updated model object data with temp IDs removed
-     * @throws EE_Error
-     */
-    protected function _replace_temp_ids_with_mappings(
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping,
-        $export_from_site_a_to_b
-    ) {
-        // if this model object's primary key is in the mapping, replace it
-        if ($model->has_primary_key_field()
-            && $model->get_primary_key_field()->is_auto_increment()
-            && isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ])
-            && isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name(
-                ) ][ $model_object_data[ $model->primary_key_name() ] ]
-            )) {
-            $model_object_data[ $model->primary_key_name() ] =
-                $old_db_to_new_db_mapping[ $model->get_this_model_name(
-                ) ][ $model_object_data[ $model->primary_key_name() ] ];
-        }
-
-        try {
-            $model_name_field                      = $model->get_field_containing_related_model_name();
-            $models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
-        } catch (EE_Error $e) {
-            $model_name_field                      = null;
-            $models_pointed_to_by_model_name_field = [];
-        }
-        foreach ($model->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
-                $models_pointed_to = $field_obj->get_model_names_pointed_to();
-                $found_a_mapping   = false;
-                foreach ($models_pointed_to as $model_pointed_to_by_fk) {
-                    if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
-                        if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
-                                $model_pointed_to_by_fk,
-                                $old_db_to_new_db_mapping,
-                                $export_from_site_a_to_b
-                            );
-                            $found_a_mapping                             = true;
-                            break;
-                        }
-                    } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
-                            $model_pointed_to_by_fk,
-                            $old_db_to_new_db_mapping,
-                            $export_from_site_a_to_b
-                        );
-                        $found_a_mapping                             = true;
-                    }
-                    // once we've found a mapping for this field no need to continue
-                    if ($found_a_mapping) {
-                        break;
-                    }
-                }
-            } else {
-                // it's a string foreign key (which we leave alone, because those are things
-                // like country names, which we'd really rather not make 2 USAs etc (we'd actually
-                // prefer to just update one)
-                // or it's just a regular value that ought to be replaced
-            }
-        }
-        //
-        if ($model instanceof EEM_Term_Taxonomy) {
-            $model_object_data = $this->_handle_split_term_ids($model_object_data);
-        }
-        return $model_object_data;
-    }
-
-
-    /**
-     * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
-     * this term-taxonomy refers to may be out-of-date so we need to update it.
-     * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
-     *
-     * @param type $model_object_data
-     * @return array new model object data
-     */
-    protected function _handle_split_term_ids($model_object_data)
-    {
-        if (isset($model_object_data['term_id'])
-            && isset($model_object_data['taxonomy'])
-            && apply_filters(
-                'FHEE__EE_Import__handle_split_term_ids__function_exists',
-                function_exists('wp_get_split_term'),
-                $model_object_data
-            )) {
-            $new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
-            if ($new_term_id) {
-                $model_object_data['term_id'] = $new_term_id;
-            }
-        }
-        return $model_object_data;
-    }
-
-
-    /**
-     * Given the object's ID and its model's name, find it int he mapping data,
-     * bearing in mind where it came from
-     *
-     * @param type   $object_id
-     * @param string $model_name
-     * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
-     * @return int
-     */
-    protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
-    {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
-        } elseif ($object_id == '0' || $object_id == '') {
-            // leave as-is
-            return $object_id;
-        } elseif ($export_from_site_a_to_b) {
-            // we couldn't find a mapping for this, and it's from a different site,
-            // so blank it out
-            return null;
-        } elseif (! $export_from_site_a_to_b) {
-            // we coudln't find a mapping for this, but it's from thsi DB anyway
-            // so let's just leave it as-is
-            return $object_id;
-        }
-    }
-
-
-    /**
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return type updated $old_db_to_new_db_mapping
-     * @throws EE_Error
-     */
-    protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        // remove the primary key, if there is one (we don't want it for inserts OR updates)
-        // we'll put it back in if we need it
-        if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
-        } else {
-            $effective_id = $model->get_index_primary_key_string($model_object_data);
-        }
-        // the model takes care of validating the CSV's input
-        try {
-            $new_id = $model->insert($model_object_data);
-            if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
-                $this->_total_inserts++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        $new_id,
-                        implode(",", $model_object_data)
-                    )
-                );
-            } else {
-                $this->_total_insert_errors++;
-                // put the ID used back in there for the error message
-                if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        __("Could not insert new %s with the csv data: %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        http_build_query($model_object_data)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } catch (EE_Error $e) {
-            $this->_total_insert_errors++;
-            if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
-            }
-            EE_Error::add_error(
-                sprintf(
-                    __("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
-                    $model->get_this_model_name(),
-                    implode(",", $model_object_data),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Given the model object data, finds the row to update and updates it
-     *
-     * @param string|int $id_in_csv
-     * @param array      $model_object_data
-     * @param EEM_Base   $model
-     * @param array      $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        try {
-            // let's keep two copies of the model object data:
-            // one for performing an update, one for everthing else
-            $model_object_data_for_update = $model_object_data;
-            if ($model->has_primary_key_field()) {
-                $conditions = [$model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]];
-                // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
-            } elseif ($model->get_combined_primary_key_fields() > 1) {
-                $conditions = [];
-                foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
-                }
-            } else {
-                $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
-            }
-
-            $success = $model->update($model_object_data_for_update, [$conditions]);
-            if ($success) {
-                $this->_total_updates++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully updated %s with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        implode(",", $model_object_data_for_update)
-                    )
-                );
-                // we should still record the mapping even though it was an update
-                // because if we were going to insert somethign but it was going to conflict
-                // we would have last-minute decided to update. So we'd like to know what we updated
-                // and so we record what record ended up being updated using the mapping
-                if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    // no primary key just a combined key
-                    $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
-                }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
-            } else {
-                $matched_items = $model->get_all([$conditions]);
-                if (! $matched_items) {
-                    // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
-                    $this->_total_update_errors++;
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                "Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            http_build_query($model_object_data),
-                            http_build_query($conditions)
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                } else {
-                    $this->_total_updates++;
-                    EE_Error::add_success(
-                        sprintf(
-                            __(
-                                "%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            implode(",", $model_object_data)
-                        )
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $this->_total_update_errors++;
-            $basic_message = sprintf(
-                __("Could not update %s with the csv data: %s because %s", "event_espresso"),
-                $model->get_this_model_name(),
-                implode(",", $model_object_data),
-                $e->getMessage()
-            );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
-            EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Gets the number of inserts performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_inserts()
-    {
-        return $this->_total_inserts;
-    }
-
-
-    /**
-     *  Gets the number of insert errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_insert_errors()
-    {
-        return $this->_total_insert_errors;
-    }
-
-
-    /**
-     *  Gets the number of updates performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_updates()
-    {
-        return $this->_total_updates;
-    }
-
-
-    /**
-     *  Gets the number of update errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_update_errors()
-    {
-        return $this->_total_update_errors;
-    }
+		$uploader = ob_get_clean();
+		return $uploader;
+	}
+
+
+	/**
+	 * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
+	 * @access public
+	 * @return boolean success
+	 * @throws EE_Error
+	 */
+	public function import()
+	{
+
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+
+		if (isset($_REQUEST['import'])) {
+			if (isset($_POST['csv_submitted'])) {
+				switch ($_FILES['file']['error'][0]) {
+					case UPLOAD_ERR_OK:
+						$error_msg = false;
+						break;
+					case UPLOAD_ERR_INI_SIZE:
+						$error_msg = __(
+							"'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_FORM_SIZE:
+						$error_msg = __(
+							'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_PARTIAL:
+						$error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_FILE:
+						$error_msg = __('No file was uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_TMP_DIR:
+						$error_msg = __('Missing a temporary folder.', "event_espresso");
+						break;
+					case UPLOAD_ERR_CANT_WRITE:
+						$error_msg = __('Failed to write file to disk.', "event_espresso");
+						break;
+					case UPLOAD_ERR_EXTENSION:
+						$error_msg = __('File upload stopped by extension.', "event_espresso");
+						break;
+					default:
+						$error_msg = __(
+							'An unknown error occurred and the file could not be uploaded',
+							"event_espresso"
+						);
+						break;
+				}
+
+				if (! $error_msg) {
+					$filename  = $_FILES['file']['name'][0];
+					$file_ext  = substr(strrchr($filename, '.'), 1);
+					$file_type = $_FILES['file']['type'][0];
+					$temp_file = $_FILES['file']['tmp_name'][0];
+					$filesize  = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+
+					if ($file_ext == 'csv') {
+						$max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+						if ($filesize < $max_upload || true) {
+							$wp_upload_dir = str_replace(['\\', '/'], '/', wp_upload_dir());
+							$path_to_file  = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+
+							if (move_uploaded_file($temp_file, $path_to_file)) {
+								// convert csv to array
+								$this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
+
+								// was data successfully stored in an array?
+								if (is_array($this->csv_array)) {
+									$import_what           = str_replace('csv_import_', '', $_REQUEST['action']);
+									$import_what           = str_replace('_', ' ', ucwords($import_what));
+									$processed_data        = $this->csv_array;
+									$this->columns_to_save = false;
+
+									// if any imports require funcky processing, we'll catch them in the switch
+									switch ($_REQUEST['action']) {
+										case "import_events":
+										case "event_list":
+											$import_what = 'Event Details';
+											break;
+
+										case 'groupon_import_csv':
+											$import_what    = 'Groupon Codes';
+											$processed_data = $this->process_groupon_codes();
+											break;
+									}
+									// save processed codes to db
+									if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
+										return true;
+									}
+								} else {
+									// no array? must be an error
+									EE_Error::add_error(
+										sprintf(__("No file seems to have been uploaded", "event_espresso")),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									return false;
+								}
+							} else {
+								EE_Error::add_error(
+									sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+						} else {
+							EE_Error::add_error(
+								sprintf(
+									__(
+										"%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
+										"event_espresso"
+									),
+									$filename,
+									$max_upload
+								),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+							return false;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				}
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
+	 *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
+	 *    next level being numeric indexes adn each value representing a model object, and the last layer down
+	 *    being keys of model fields and their proposed values.
+	 *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
+	 *    If the CSV data says (in the metadata row) that it's from the SAME database,
+	 *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
+	 *    IDs DON'T exist in the database, they're treated as temporary IDs,
+	 *    which can used elsewhere to refer to the same object. Once an item
+	 *    with a temporary ID gets inserted, we record its mapping from temporary
+	 *    ID to real ID, and use the real ID in place of the temporary ID
+	 *    when that temporary ID was used as a foreign key.
+	 *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
+	 *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
+	 *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
+	 *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
+	 *    An important exception are non-auto-increment primary keys. If one entry in the
+	 *    CSV file has the same ID as one in the DB, we assume they are meant to be
+	 *    the same item, and instead update the item in the DB with that same ID.
+	 *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
+	 *    time you import a CSV from a different site, we remember their mappings, and
+	 * will try to update the item in the DB instead of inserting another item (eg
+	 * if we previously imported an event with temporary ID 1, and then it got a
+	 * real ID of 123, we remember that. So the next time we import an event with
+	 * temporary ID, from the same site, we know that it's real ID is 123, and will
+	 * update that event, instead of adding a new event).
+	 *
+	 * @access public
+	 * @param array $csv_data_array - the array containing the csv data produced from
+	 *                              EE_CSV::import_csv_to_model_data_array()
+	 * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
+	 *                              fields they will be saved to
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
+	{
+		$success = false;
+		$error   = false;
+		// whther to treat this import as if it's data froma different database or not
+		// ie, if it IS from a different database, ignore foreign keys whihf
+		$export_from_site_a_to_b = true;
+		// first level of array is not table information but a table name was passed to the function
+		// array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
+		if ($model_name) {
+			$csv_data_array = [$csv_data_array];
+		}
+		// begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
+		$old_site_url = 'none-specified';
+		// hanlde metadata
+		if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
+			$csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+			// ok so its metadata, dont try to save it to ehte db obviously...
+			if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from the same database, so attempting to update data",
+							"event_espresso"
+						)
+					)
+				);
+				$export_from_site_a_to_b = false;
+			} else {
+				$old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
+							"event_espresso"
+						),
+						$old_site_url,
+						site_url()
+					)
+				);
+			};
+			unset($csv_data_array[ EE_CSV::metadata_header ]);
+		}
+		/**
+		 * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
+		 * the value will be the newly-inserted ID.
+		 * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
+		 */
+		$old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), []);
+		if ($old_db_to_new_db_mapping) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						"We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
+						"event_espresso"
+					),
+					$old_site_url,
+					site_url()
+				)
+			);
+		}
+		$old_db_to_new_db_mapping = $this->save_data_rows_to_db(
+			$csv_data_array,
+			$export_from_site_a_to_b,
+			$old_db_to_new_db_mapping
+		);
+
+		// save the mapping from old db to new db in case they try re-importing the same data from the same website again
+		update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+
+		if ($this->_total_updates > 0) {
+			EE_Error::add_success(
+				sprintf(
+					__("%s existing records in the database were updated.", "event_espresso"),
+					$this->_total_updates
+				)
+			);
+			$success = true;
+		}
+		if ($this->_total_inserts > 0) {
+			EE_Error::add_success(
+				sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
+			);
+			$success = true;
+		}
+
+		if ($this->_total_update_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
+						"event_espresso"
+					),
+					$this->_total_update_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+		if ($this->_total_insert_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
+						"event_espresso"
+					),
+					$this->_total_insert_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+
+		// lastly, we need to update the datetime and ticket sold amounts
+		// as those may have been affected by this
+		EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
+
+		// if there was at least one success and absolutely no errors
+		if ($success && ! $error) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Processes the array of data, given the knowledge that it's from the same database or a different one,
+	 * and the mapping from temporary IDs to real IDs.
+	 * If the data is from a different database, we treat the primary keys and their corresponding
+	 * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
+	 * in the real target database. As items are inserted, their temporary primary keys
+	 * are mapped to the real IDs in the target database. Also, before doing any update or
+	 * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
+	 * An exception: string primary keys are treated as real IDs, or else we'd need to
+	 * dynamically generate new string primary keys which would be very awkward for the country table etc.
+	 * Also, models with no primary key are strange too. We combine use their primary key INDEX (a
+	 * combination of fields) to create a unique string identifying the row and store
+	 * those in the mapping.
+	 *
+	 * If the data is from the same database, we usually treat primary keys as real IDs.
+	 * An exception is if there is nothing in the database for that ID. If that's the case,
+	 * we need to insert a new row for that ID, and then map from the non-existent ID
+	 * to the newly-inserted real ID.
+	 *
+	 * @param array   $csv_data_array
+	 * @param boolean $export_from_site_a_to_b
+	 * @param array   $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save_data_rows_to_db(
+		array $csv_data_array,
+		$export_from_site_a_to_b,
+		array $old_db_to_new_db_mapping
+	) {
+		foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
+			// now check that assumption was correct. If
+			if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
+				$model_name = $model_name_in_csv_data;
+			} else {
+				// no table info in the array and no table name passed to the function?? FAIL
+				EE_Error::add_error(
+					__(
+						'No table information was specified and/or found, therefore the import could not be completed',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return [];
+			}
+			/* @var $model EEM_Base */
+			$model = EE_Registry::instance()->load_model($model_name);
+
+			// so without further ado, scanning all the data provided for primary keys and their initial values
+			foreach ($model_data_from_import as $model_object_data) {
+				// before we do ANYTHING, make sure the csv row wasn't just completely blank
+				$row_is_completely_empty = true;
+				foreach ($model_object_data as $field) {
+					if ($field) {
+						$row_is_completely_empty = false;
+					}
+				}
+				if ($row_is_completely_empty) {
+					continue;
+				}
+				// find the PK in the row of data (or a combined key if
+				// there is no primary key)
+				if ($model->has_primary_key_field()) {
+					$id_in_csv = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					$id_in_csv = $model->get_index_primary_key_string($model_object_data);
+				}
+
+
+				$model_object_data = $this->_replace_temp_ids_with_mappings(
+					$model_object_data,
+					$model,
+					$old_db_to_new_db_mapping,
+					$export_from_site_a_to_b
+				);
+				// now we need to decide if we're going to add a new model object given the $model_object_data,
+				// or just update.
+				if ($export_from_site_a_to_b) {
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {// this is just a re-import
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
+						$id_in_csv,
+						$model_object_data,
+						$model
+					);
+				}
+				if ($what_to_do == self::do_nothing) {
+					continue;
+				}
+
+				// double-check we actually want to insert, if that's what we're planning
+				// based on whether this item would be unique in the DB or not
+				if ($what_to_do == self::do_insert) {
+					// we're supposed to be inserting. But wait, will this thing
+					// be acceptable if inserted?
+					$conflicting = $model->get_one_conflicting($model_object_data, false);
+					if ($conflicting) {
+						// ok, this item would conflict if inserted. Just update the item that it conflicts with.
+						$what_to_do = self::do_update;
+						// and if this model has a primary key, remember its mapping
+						if ($model->has_primary_key_field()) {
+							$old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
+							$model_object_data[ $model->primary_key_name() ]       = $conflicting->ID();
+						} else {
+							// we want to update this conflicting item, instead of inserting a conflicting item
+							// so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
+							// for the WHERE conditions in the update). At the time of this comment, there were no models like this
+							foreach ($model->get_combined_primary_key_fields() as $key_field) {
+								$model_object_data[ $key_field->get_name() ] = $conflicting->get(
+									$key_field->get_name()
+								);
+							}
+						}
+					}
+				}
+				if ($what_to_do == self::do_insert) {
+					$old_db_to_new_db_mapping = $this->_insert_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} elseif ($what_to_do == self::do_update) {
+					$old_db_to_new_db_mapping = $this->_update_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
+								'event_espresso'
+							),
+							$what_to_do
+						)
+					);
+				}
+			}
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Decides whether or not to insert, given that this data is from another database.
+	 * So, if the primary key of this $model_object_data already exists in the database,
+	 * it's just a coincidence and we should still insert. The only time we should
+	 * update is when we know what it maps to, or there's something that would
+	 * conflict (and we should instead just update that conflicting thing)
+	 *
+	 * @param string   $id_in_csv
+	 * @param array    $model_object_data        by reference so it can be modified
+	 * @param EEM_Base $model
+	 * @param array    $old_db_to_new_db_mapping by reference so it can be modified
+	 * @return string one of the consts on this class that starts with do_*
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
+		$id_in_csv,
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping
+	) {
+		$model_name = $model->get_this_model_name();
+		// if it's a site-to-site export-and-import, see if this modelobject's id
+		// in the old data that we know of
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+
+	/**
+	 * If this thing basically already exists in the database, we want to update it;
+	 * otherwise insert it (ie, someone tweaked the CSV file, or the item was
+	 * deleted in the database so it should be re-inserted)
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
+		$id_in_csv,
+		$model_object_data,
+		$model
+	) {
+		// in this case, check if this thing ACTUALLY exists in the database
+		if ($model->get_one_conflicting($model_object_data)) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+
+	/**
+	 * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
+	 * with their mapped real IDs. Eg, if importing from site A to B, the mapping
+	 * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
+	 * So this function searches for any event temp Ids called "my_event_id" and
+	 * replaces them with 123.
+	 * Also, if there is no temp ID for the INT foreign keys from another database,
+	 * replaces them with 0 or the field's default.
+	 *
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @param boolean  $export_from_site_a_to_b
+	 * @return array updated model object data with temp IDs removed
+	 * @throws EE_Error
+	 */
+	protected function _replace_temp_ids_with_mappings(
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping,
+		$export_from_site_a_to_b
+	) {
+		// if this model object's primary key is in the mapping, replace it
+		if ($model->has_primary_key_field()
+			&& $model->get_primary_key_field()->is_auto_increment()
+			&& isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ])
+			&& isset(
+				$old_db_to_new_db_mapping[ $model->get_this_model_name(
+				) ][ $model_object_data[ $model->primary_key_name() ] ]
+			)) {
+			$model_object_data[ $model->primary_key_name() ] =
+				$old_db_to_new_db_mapping[ $model->get_this_model_name(
+				) ][ $model_object_data[ $model->primary_key_name() ] ];
+		}
+
+		try {
+			$model_name_field                      = $model->get_field_containing_related_model_name();
+			$models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
+		} catch (EE_Error $e) {
+			$model_name_field                      = null;
+			$models_pointed_to_by_model_name_field = [];
+		}
+		foreach ($model->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
+				$models_pointed_to = $field_obj->get_model_names_pointed_to();
+				$found_a_mapping   = false;
+				foreach ($models_pointed_to as $model_pointed_to_by_fk) {
+					if ($model_name_field) {
+						$value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+						if ($value_of_model_name_field == $model_pointed_to_by_fk) {
+							$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+								$model_object_data[ $field_obj->get_name() ],
+								$model_pointed_to_by_fk,
+								$old_db_to_new_db_mapping,
+								$export_from_site_a_to_b
+							);
+							$found_a_mapping                             = true;
+							break;
+						}
+					} else {
+						$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+							$model_object_data[ $field_obj->get_name() ],
+							$model_pointed_to_by_fk,
+							$old_db_to_new_db_mapping,
+							$export_from_site_a_to_b
+						);
+						$found_a_mapping                             = true;
+					}
+					// once we've found a mapping for this field no need to continue
+					if ($found_a_mapping) {
+						break;
+					}
+				}
+			} else {
+				// it's a string foreign key (which we leave alone, because those are things
+				// like country names, which we'd really rather not make 2 USAs etc (we'd actually
+				// prefer to just update one)
+				// or it's just a regular value that ought to be replaced
+			}
+		}
+		//
+		if ($model instanceof EEM_Term_Taxonomy) {
+			$model_object_data = $this->_handle_split_term_ids($model_object_data);
+		}
+		return $model_object_data;
+	}
+
+
+	/**
+	 * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
+	 * this term-taxonomy refers to may be out-of-date so we need to update it.
+	 * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
+	 *
+	 * @param type $model_object_data
+	 * @return array new model object data
+	 */
+	protected function _handle_split_term_ids($model_object_data)
+	{
+		if (isset($model_object_data['term_id'])
+			&& isset($model_object_data['taxonomy'])
+			&& apply_filters(
+				'FHEE__EE_Import__handle_split_term_ids__function_exists',
+				function_exists('wp_get_split_term'),
+				$model_object_data
+			)) {
+			$new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
+			if ($new_term_id) {
+				$model_object_data['term_id'] = $new_term_id;
+			}
+		}
+		return $model_object_data;
+	}
+
+
+	/**
+	 * Given the object's ID and its model's name, find it int he mapping data,
+	 * bearing in mind where it came from
+	 *
+	 * @param type   $object_id
+	 * @param string $model_name
+	 * @param array  $old_db_to_new_db_mapping
+	 * @param type   $export_from_site_a_to_b
+	 * @return int
+	 */
+	protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
+	{
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
+			return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+		} elseif ($object_id == '0' || $object_id == '') {
+			// leave as-is
+			return $object_id;
+		} elseif ($export_from_site_a_to_b) {
+			// we couldn't find a mapping for this, and it's from a different site,
+			// so blank it out
+			return null;
+		} elseif (! $export_from_site_a_to_b) {
+			// we coudln't find a mapping for this, but it's from thsi DB anyway
+			// so let's just leave it as-is
+			return $object_id;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return type updated $old_db_to_new_db_mapping
+	 * @throws EE_Error
+	 */
+	protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		// remove the primary key, if there is one (we don't want it for inserts OR updates)
+		// we'll put it back in if we need it
+		if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
+			$effective_id = $model_object_data[ $model->primary_key_name() ];
+			unset($model_object_data[ $model->primary_key_name() ]);
+		} else {
+			$effective_id = $model->get_index_primary_key_string($model_object_data);
+		}
+		// the model takes care of validating the CSV's input
+		try {
+			$new_id = $model->insert($model_object_data);
+			if ($new_id) {
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+				$this->_total_inserts++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						$new_id,
+						implode(",", $model_object_data)
+					)
+				);
+			} else {
+				$this->_total_insert_errors++;
+				// put the ID used back in there for the error message
+				if ($model->has_primary_key_field()) {
+					$model_object_data[ $model->primary_key_name() ] = $effective_id;
+				}
+				EE_Error::add_error(
+					sprintf(
+						__("Could not insert new %s with the csv data: %s", "event_espresso"),
+						$model->get_this_model_name(),
+						http_build_query($model_object_data)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} catch (EE_Error $e) {
+			$this->_total_insert_errors++;
+			if ($model->has_primary_key_field()) {
+				$model_object_data[ $model->primary_key_name() ] = $effective_id;
+			}
+			EE_Error::add_error(
+				sprintf(
+					__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
+					$model->get_this_model_name(),
+					implode(",", $model_object_data),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Given the model object data, finds the row to update and updates it
+	 *
+	 * @param string|int $id_in_csv
+	 * @param array      $model_object_data
+	 * @param EEM_Base   $model
+	 * @param array      $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		try {
+			// let's keep two copies of the model object data:
+			// one for performing an update, one for everthing else
+			$model_object_data_for_update = $model_object_data;
+			if ($model->has_primary_key_field()) {
+				$conditions = [$model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]];
+				// remove the primary key because we shouldn't use it for updating
+				unset($model_object_data_for_update[ $model->primary_key_name() ]);
+			} elseif ($model->get_combined_primary_key_fields() > 1) {
+				$conditions = [];
+				foreach ($model->get_combined_primary_key_fields() as $key_field) {
+					$conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+				}
+			} else {
+				$model->primary_key_name(
+				);// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+			}
+
+			$success = $model->update($model_object_data_for_update, [$conditions]);
+			if ($success) {
+				$this->_total_updates++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully updated %s with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						implode(",", $model_object_data_for_update)
+					)
+				);
+				// we should still record the mapping even though it was an update
+				// because if we were going to insert somethign but it was going to conflict
+				// we would have last-minute decided to update. So we'd like to know what we updated
+				// and so we record what record ended up being updated using the mapping
+				if ($model->has_primary_key_field()) {
+					$new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					// no primary key just a combined key
+					$new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
+				}
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+			} else {
+				$matched_items = $model->get_all([$conditions]);
+				if (! $matched_items) {
+					// no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
+					$this->_total_update_errors++;
+					EE_Error::add_error(
+						sprintf(
+							__(
+								"Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							http_build_query($model_object_data),
+							http_build_query($conditions)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				} else {
+					$this->_total_updates++;
+					EE_Error::add_success(
+						sprintf(
+							__(
+								"%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							implode(",", $model_object_data)
+						)
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$this->_total_update_errors++;
+			$basic_message = sprintf(
+				__("Could not update %s with the csv data: %s because %s", "event_espresso"),
+				$model->get_this_model_name(),
+				implode(",", $model_object_data),
+				$e->getMessage()
+			);
+			$debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+			EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Gets the number of inserts performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_inserts()
+	{
+		return $this->_total_inserts;
+	}
+
+
+	/**
+	 *  Gets the number of insert errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_insert_errors()
+	{
+		return $this->_total_insert_errors;
+	}
+
+
+	/**
+	 *  Gets the number of updates performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_updates()
+	{
+		return $this->_total_updates;
+	}
+
+
+	/**
+	 *  Gets the number of update errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_update_errors()
+	{
+		return $this->_total_update_errors;
+	}
 }

Spacing +44 added lines, -44 removed lines

@@ -142,7 +142,7 @@ 
     public function import()
     {
 
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
 
         if (isset($_REQUEST['import'])) {
@@ -186,18 +186,18 @@ 
                         break;
                 }
 
-                if (! $error_msg) {
+                if ( ! $error_msg) {
                     $filename  = $_FILES['file']['name'][0];
                     $file_ext  = substr(strrchr($filename, '.'), 1);
                     $file_type = $_FILES['file']['type'][0];
                     $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize  = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+                    $filesize  = $_FILES['file']['size'][0] / 1024; // convert from bytes to KB
 
                     if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+                        $max_upload = $this->EE_CSV->get_max_upload_size(); // max upload size in KB
                         if ($filesize < $max_upload || true) {
                             $wp_upload_dir = str_replace(['\\', '/'], '/', wp_upload_dir());
-                            $path_to_file  = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+                            $path_to_file  = $wp_upload_dir['basedir'].'/espresso/'.$filename;
 
                             if (move_uploaded_file($temp_file, $path_to_file)) {
                                 // convert csv to array
@@ -331,8 +331,8 @@ 
         // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
         $old_site_url = 'none-specified';
         // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+        if (isset($csv_data_array[EE_CSV::metadata_header])) {
+            $csv_metadata = array_shift($csv_data_array[EE_CSV::metadata_header]);
             // ok so its metadata, dont try to save it to ehte db obviously...
             if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
                 EE_Error::add_attention(
@@ -357,14 +357,14 @@ 
                     )
                 );
             };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
+            unset($csv_data_array[EE_CSV::metadata_header]);
         }
         /**
          * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
          * the value will be the newly-inserted ID.
          * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
          */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), []);
+        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from'.sanitize_title($old_site_url), []);
         if ($old_db_to_new_db_mapping) {
             EE_Error::add_attention(
                 sprintf(
@@ -384,7 +384,7 @@ 
         );
 
         // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+        update_option('ee_id_mapping_from'.sanitize_title($old_site_url), $old_db_to_new_db_mapping);
 
         if ($this->_total_updates > 0) {
             EE_Error::add_success(
@@ -512,7 +512,7 @@ 
                 // find the PK in the row of data (or a combined key if
                 // there is no primary key)
                 if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
+                    $id_in_csv = $model_object_data[$model->primary_key_name()];
                 } else {
                     $id_in_csv = $model->get_index_primary_key_string($model_object_data);
                 }
@@ -555,14 +555,14 @@ 
                         $what_to_do = self::do_update;
                         // and if this model has a primary key, remember its mapping
                         if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ]       = $conflicting->ID();
+                            $old_db_to_new_db_mapping[$model_name][$id_in_csv] = $conflicting->ID();
+                            $model_object_data[$model->primary_key_name()]       = $conflicting->ID();
                         } else {
                             // we want to update this conflicting item, instead of inserting a conflicting item
                             // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
                             // for the WHERE conditions in the update). At the time of this comment, there were no models like this
                             foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
+                                $model_object_data[$key_field->get_name()] = $conflicting->get(
                                     $key_field->get_name()
                                 );
                             }
@@ -622,7 +622,7 @@ 
         $model_name = $model->get_this_model_name();
         // if it's a site-to-site export-and-import, see if this modelobject's id
         // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+        if (isset($old_db_to_new_db_mapping[$model_name][$id_in_csv])) {
             return self::do_update;
         } else {
             return self::do_insert;
@@ -680,14 +680,14 @@ 
         // if this model object's primary key is in the mapping, replace it
         if ($model->has_primary_key_field()
             && $model->get_primary_key_field()->is_auto_increment()
-            && isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ])
+            && isset($old_db_to_new_db_mapping[$model->get_this_model_name()])
             && isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name(
-                ) ][ $model_object_data[ $model->primary_key_name() ] ]
+                $old_db_to_new_db_mapping[$model->get_this_model_name(
+                )][$model_object_data[$model->primary_key_name()]]
             )) {
-            $model_object_data[ $model->primary_key_name() ] =
-                $old_db_to_new_db_mapping[ $model->get_this_model_name(
-                ) ][ $model_object_data[ $model->primary_key_name() ] ];
+            $model_object_data[$model->primary_key_name()] =
+                $old_db_to_new_db_mapping[$model->get_this_model_name(
+                )][$model_object_data[$model->primary_key_name()]];
         }
 
         try {
@@ -703,25 +703,25 @@ 
                 $found_a_mapping   = false;
                 foreach ($models_pointed_to as $model_pointed_to_by_fk) {
                     if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+                        $value_of_model_name_field = $model_object_data[$model_name_field->get_name()];
                         if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
+                            $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                                $model_object_data[$field_obj->get_name()],
                                 $model_pointed_to_by_fk,
                                 $old_db_to_new_db_mapping,
                                 $export_from_site_a_to_b
                             );
-                            $found_a_mapping                             = true;
+                            $found_a_mapping = true;
                             break;
                         }
                     } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
+                        $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                            $model_object_data[$field_obj->get_name()],
                             $model_pointed_to_by_fk,
                             $old_db_to_new_db_mapping,
                             $export_from_site_a_to_b
                         );
-                        $found_a_mapping                             = true;
+                        $found_a_mapping = true;
                     }
                     // once we've found a mapping for this field no need to continue
                     if ($found_a_mapping) {
@@ -781,8 +781,8 @@ 
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
     {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+        if (isset($old_db_to_new_db_mapping[$model_name][$object_id])) {
+            return $old_db_to_new_db_mapping[$model_name][$object_id];
         } elseif ($object_id == '0' || $object_id == '') {
             // leave as-is
             return $object_id;
@@ -790,7 +790,7 @@ 
             // we couldn't find a mapping for this, and it's from a different site,
             // so blank it out
             return null;
-        } elseif (! $export_from_site_a_to_b) {
+        } elseif ( ! $export_from_site_a_to_b) {
             // we coudln't find a mapping for this, but it's from thsi DB anyway
             // so let's just leave it as-is
             return $object_id;
@@ -812,8 +812,8 @@ 
         // remove the primary key, if there is one (we don't want it for inserts OR updates)
         // we'll put it back in if we need it
         if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
+            $effective_id = $model_object_data[$model->primary_key_name()];
+            unset($model_object_data[$model->primary_key_name()]);
         } else {
             $effective_id = $model->get_index_primary_key_string($model_object_data);
         }
@@ -821,7 +821,7 @@ 
         try {
             $new_id = $model->insert($model_object_data);
             if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_id;
                 $this->_total_inserts++;
                 EE_Error::add_success(
                     sprintf(
@@ -835,7 +835,7 @@ 
                 $this->_total_insert_errors++;
                 // put the ID used back in there for the error message
                 if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                    $model_object_data[$model->primary_key_name()] = $effective_id;
                 }
                 EE_Error::add_error(
                     sprintf(
@@ -851,7 +851,7 @@ 
         } catch (EE_Error $e) {
             $this->_total_insert_errors++;
             if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                $model_object_data[$model->primary_key_name()] = $effective_id;
             }
             EE_Error::add_error(
                 sprintf(
@@ -885,17 +885,17 @@ 
             // one for performing an update, one for everthing else
             $model_object_data_for_update = $model_object_data;
             if ($model->has_primary_key_field()) {
-                $conditions = [$model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]];
+                $conditions = [$model->primary_key_name() => $model_object_data[$model->primary_key_name()]];
                 // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
+                unset($model_object_data_for_update[$model->primary_key_name()]);
             } elseif ($model->get_combined_primary_key_fields() > 1) {
                 $conditions = [];
                 foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+                    $conditions[$key_field->get_name()] = $model_object_data[$key_field->get_name()];
                 }
             } else {
                 $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+                ); // this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
             }
 
             $success = $model->update($model_object_data_for_update, [$conditions]);
@@ -913,15 +913,15 @@ 
                 // we would have last-minute decided to update. So we'd like to know what we updated
                 // and so we record what record ended up being updated using the mapping
                 if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+                    $new_key_for_mapping = $model_object_data[$model->primary_key_name()];
                 } else {
                     // no primary key just a combined key
                     $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
                 }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_key_for_mapping;
             } else {
                 $matched_items = $model->get_all([$conditions]);
-                if (! $matched_items) {
+                if ( ! $matched_items) {
                     // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
                     $this->_total_update_errors++;
                     EE_Error::add_error(
@@ -960,7 +960,7 @@ 
                 implode(",", $model_object_data),
                 $e->getMessage()
             );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+            $debug_message = $basic_message.' Stack trace: '.$e->getTraceAsString();
             EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
         }
         return $old_db_to_new_db_mapping;

core/helpers/EEH_Activation.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -590,7 +590,7 @@ 
      * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
      * The role being used to check is filterable.
      *
-     * @return mixed null|int WP_user ID or NULL
+     * @return integer|null null|int WP_user ID or NULL
      * @throws EE_Error
      * @throws ReflectionException
      * @since  4.6.0
@@ -770,7 +770,7 @@ 
      * @access     public
      * @static
      * @param string $table_name
-     * @return bool | int
+     * @return integer | int
      * @throws EE_Error
      * @throws ReflectionException
      * @deprecated instead use TableManager::dropTable()
@@ -788,7 +788,7 @@ 
      * @static
      * @param string $table_name
      * @param string $index_name
-     * @return bool | int
+     * @return integer | int
      * @throws EE_Error
      * @throws ReflectionException
      * @deprecated instead use TableManager::dropIndex()

Spacing +53 added lines, -53 removed lines

@@ -58,7 +58,7 @@ 
      */
     public static function getTableAnalysis()
     {
-        if (! self::$table_analysis instanceof TableAnalysis) {
+        if ( ! self::$table_analysis instanceof TableAnalysis) {
             self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
         }
         return self::$table_analysis;
@@ -72,7 +72,7 @@ 
      */
     public static function getTableManager()
     {
-        if (! self::$table_manager instanceof TableManager) {
+        if ( ! self::$table_manager instanceof TableManager) {
             self::$table_manager = EE_Registry::instance()->create('TableManager', [], true);
         }
         return self::$table_manager;
@@ -193,7 +193,7 @@ 
         if ($which_to_include === 'old') {
             $cron_tasks = array_filter(
                 $cron_tasks,
-                function ($value) {
+                function($value) {
                     return $value === EEH_Activation::cron_task_no_longer_in_use;
                 }
             );
@@ -223,7 +223,7 @@ 
     {
 
         foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 /**
                  * This allows client code to define the initial start timestamp for this schedule.
                  */
@@ -274,15 +274,15 @@ 
         foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
             if (is_array($hooks_to_fire_at_time)) {
                 foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (isset($ee_cron_tasks_to_remove[ $hook_name ])
-                        && is_array($ee_cron_tasks_to_remove[ $hook_name ])
+                    if (isset($ee_cron_tasks_to_remove[$hook_name])
+                        && is_array($ee_cron_tasks_to_remove[$hook_name])
                     ) {
-                        unset($crons[ $timestamp ][ $hook_name ]);
+                        unset($crons[$timestamp][$hook_name]);
                     }
                 }
                 // also take care of any empty cron timestamps.
                 if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[ $timestamp ]);
+                    unset($crons[$timestamp]);
                 }
             }
         }
@@ -328,7 +328,7 @@ 
             3
         );
         // EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             delete_option(EE_Config::LOG_NAME);
         }
     }
@@ -343,7 +343,7 @@ 
     public static function load_calendar_config()
     {
         // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
+        $plugins = glob(WP_PLUGIN_DIR.'/*', GLOB_ONLYDIR);
         if (empty($plugins)) {
             return;
         }
@@ -359,7 +359,7 @@ 
                 || strpos($plugin, 'calendar') !== false
             ) {
                 // this is what we are looking for
-                $calendar_config = $plugin_path . '/EE_Calendar_Config.php';
+                $calendar_config = $plugin_path.'/EE_Calendar_Config.php';
                 // does it exist in this folder ?
                 if (is_readable($calendar_config)) {
                     // YEAH! let's load it
@@ -453,7 +453,7 @@ 
                 'code' => 'ESPRESSO_CANCELLED',
             ],
         ];
-        $EE_Core_Config        = EE_Registry::instance()->CFG->core;
+        $EE_Core_Config = EE_Registry::instance()->CFG->core;
         foreach ($critical_pages as $critical_page) {
             // is critical page ID set in config ?
             if ($EE_Core_Config->{$critical_page['id']} !== false) {
@@ -484,7 +484,7 @@ 
             ) {
                 // update Config with post ID
                 $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
+                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
                     $msg = __(
                         'The Event Espresso critical page configuration settings could not be updated.',
                         'event_espresso'
@@ -507,7 +507,7 @@ 
                         'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+                    '<a href="'.admin_url('admin.php?page=espresso_general_settings&action=critical_pages').'">'
                     . __('Event Espresso Critical Pages Settings', 'event_espresso')
                     . '</a>'
                 )
@@ -532,7 +532,7 @@ 
     public static function get_page_by_ee_shortcode($ee_shortcode)
     {
         global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
+        $shortcode_and_opening_bracket = '['.$ee_shortcode;
         $post_id                       =
             $wpdb->get_var(
                 "SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1"
@@ -561,11 +561,11 @@ 
             'post_status'    => 'publish',
             'post_type'      => 'page',
             'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
+            'post_content'   => '['.$critical_page['code'].']',
         ];
 
         $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
+        if ( ! $post_id) {
             $msg = sprintf(
                 __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
                 $critical_page['name']
@@ -574,7 +574,7 @@ 
             return $critical_page;
         }
         // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
+        if ( ! $critical_page['post'] = get_post($post_id)) {
             $msg = sprintf(
                 __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
                 $critical_page['name']
@@ -599,7 +599,7 @@ 
     public static function get_default_creator_id()
     {
         global $wpdb;
-        if (! empty(self::$_default_creator_id)) {
+        if ( ! empty(self::$_default_creator_id)) {
             return self::$_default_creator_id;
         }/**/
         $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
@@ -615,7 +615,7 @@ 
         $capabilities_key = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query            = $wpdb->prepare(
             "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
+            '%'.$role_to_check.'%'
         );
         $user_id          = $wpdb->get_var($query);
         $user_id          = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
@@ -654,8 +654,8 @@ 
             return;
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+        if ( ! function_exists('dbDelta')) {
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -664,9 +664,9 @@ 
             // ok, delete the table... but ONLY if it's empty
             $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
             // table is NOT empty, are you SURE you want to delete this table ???
-            if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
                 EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } elseif (! $deleted_safely) {
+            } elseif ( ! $deleted_safely) {
                 // so we should be more cautious rather than just dropping tables so easily
                 error_log(
                     sprintf(
@@ -878,13 +878,13 @@ 
             // reset values array
             $QSG_values = [];
             // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
+            if ( ! in_array("$QSG_system", $question_groups)) {
                 // add it
                 switch ($QSG_system) {
                     case 1:
                         $QSG_values = [
                             'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -896,7 +896,7 @@ 
                     case 2:
                         $QSG_values = [
                             'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -907,14 +907,14 @@ 
                         break;
                 }
                 // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
+                if ( ! empty($QSG_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
                         $QSG_values,
                         ['%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d']
                     );
-                    $QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
+                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
                 }
             }
         }
@@ -929,7 +929,7 @@ 
         $address_system_group_questions  = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
         $system_questions_not_in_group   = ['email_confirm'];
         // merge all of the system questions we should have
-        $QST_systems       = array_merge(
+        $QST_systems = array_merge(
             $personal_system_group_questions,
             $address_system_group_questions,
             $system_questions_not_in_group
@@ -941,7 +941,7 @@ 
             // reset values array
             $QST_values = [];
             // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
+            if ( ! in_array($QST_system, $questions)) {
                 // add it
                 switch ($QST_system) {
                     case 'fname':
@@ -1126,7 +1126,7 @@ 
                         ];
                         break;
                 }
-                if (! empty($QST_values)) {
+                if ( ! empty($QST_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -1144,8 +1144,8 @@ 
                         // QST_system should not be assigned to any group
                         continue;
                     }
-                    if (isset($QSG_IDs[ $system_question_we_want ])) {
-                        $QSG_ID = $QSG_IDs[ $system_question_we_want ];
+                    if (isset($QSG_IDs[$system_question_we_want])) {
+                        $QSG_ID = $QSG_IDs[$system_question_we_want];
                     } else {
                         $id_col = EEM_Question_Group::instance()
                                                     ->get_col([['QSG_system' => $system_question_we_want]]);
@@ -1194,7 +1194,7 @@ 
      */
     public static function insert_default_payment_methods()
     {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+        if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
         } else {
@@ -1328,7 +1328,7 @@ 
                 // if already active or has already been activated before we skip
                 // (otherwise we might reactivate something user's intentionally deactivated.)
                 // we also skip if the message type is not installed.
-                if (! isset($installed_message_types[ $default_message_type_name_for_messenger ])
+                if ( ! isset($installed_message_types[$default_message_type_name_for_messenger])
                     || $message_resource_manager->has_message_type_been_activated_for_messenger(
                         $default_message_type_name_for_messenger,
                         $active_messenger->name
@@ -1349,7 +1349,7 @@ 
                 false
             );
             // activate the templates for these message types
-            if (! empty($default_message_type_names_to_activate)) {
+            if ( ! empty($default_message_type_names_to_activate)) {
                 $templates_created = EEH_MSG_Template::generate_new_templates(
                     $active_messenger->name,
                     $default_message_type_names_for_messenger,
@@ -1382,13 +1382,13 @@ 
             $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
             // verify the default message types match an installed message type.
             foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (! isset($installed_message_types[ $name ])
+                if ( ! isset($installed_message_types[$name])
                     || $message_resource_manager->has_message_type_been_activated_for_messenger(
                         $name,
                         $messenger_to_generate->name
                     )
                 ) {
-                    unset($default_message_type_names_for_messenger[ $key ]);
+                    unset($default_message_type_names_for_messenger[$key]);
                 }
             }
             // in previous iterations, the active_messengers option in the db
@@ -1402,7 +1402,7 @@ 
                 false
             );
             // create any templates needing created (or will reactivate templates already generated as necessary).
-            if (! empty($default_message_type_names_for_messenger)) {
+            if ( ! empty($default_message_type_names_for_messenger)) {
                 $templates_generated = EEH_MSG_Template::generate_new_templates(
                     $messenger_to_generate->name,
                     $default_message_type_names_for_messenger,
@@ -1437,13 +1437,13 @@ 
             // if installed messenger is a messenger that should be activated on install
             // and is not already active
             // and has never been activated
-            if (! $installed_messenger->activate_on_install
-                || isset($active_messengers[ $installed_messenger->name ])
-                || isset($has_activated[ $installed_messenger->name ])
+            if ( ! $installed_messenger->activate_on_install
+                || isset($active_messengers[$installed_messenger->name])
+                || isset($has_activated[$installed_messenger->name])
             ) {
                 continue;
             }
-            $messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
+            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
         }
         return $messengers_to_generate;
     }
@@ -1483,7 +1483,7 @@ 
         // this creates an array for tracking events that have no active ticket prices created
         // this allows us to warn admins of the situation so that it can be corrected
         $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
+        if ( ! $espresso_no_ticket_prices) {
             add_option('ee_no_ticket_prices', [], '', false);
         }
     }
@@ -1522,7 +1522,7 @@ 
             }
         }
         // get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",", $ee_post_types).")";
         $cpt_ids = $wpdb->get_col($query);
         // delete each post meta and term relations too
         foreach ($cpt_ids as $post_id) {
@@ -1553,7 +1553,7 @@ 
                                 || ! $table->is_global()// not main site,but not global either. nuke it
                             )
                         ) {
-                            $tables[ $table->get_table_name() ] = $table->get_table_name();
+                            $tables[$table->get_table_name()] = $table->get_table_name();
                         }
                     }
                 }
@@ -1570,7 +1570,7 @@ 
             'esp_rule',
         ];
         foreach ($tables_without_models as $table) {
-            $tables[ $table ] = $table;
+            $tables[$table] = $table;
         }
         return EEH_Activation::getTableManager()->dropTables($tables);
     }
@@ -1649,14 +1649,14 @@ 
         $undeleted_options = [];
         foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
             if ($no_wildcard) {
-                if (! delete_option($option_name)) {
+                if ( ! delete_option($option_name)) {
                     $undeleted_options[] = $option_name;
                 }
             } else {
                 $option_names_to_delete_from_wildcard =
                     $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
                 foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if (! delete_option($option_name_from_wildcard)) {
+                    if ( ! delete_option($option_name_from_wildcard)) {
                         $undeleted_options[] = $option_name_from_wildcard;
                     }
                 }
@@ -1668,20 +1668,20 @@ 
             $db_update_sans_ee4 = [];
             foreach ($espresso_db_update as $version => $times_activated) {
                 if ((string) $version[0] === '3') {// if its NON EE4
-                    $db_update_sans_ee4[ $version ] = $times_activated;
+                    $db_update_sans_ee4[$version] = $times_activated;
                 }
             }
             update_option('espresso_db_update', $db_update_sans_ee4);
         }
         $errors = '';
-        if (! empty($undeleted_options)) {
+        if ( ! empty($undeleted_options)) {
             $errors .= sprintf(
                 __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
                 '<br/>',
                 implode(',<br/>', $undeleted_options)
             );
         }
-        if (! empty($errors)) {
+        if ( ! empty($errors)) {
             EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
         }
     }

Indentation +1676 added lines, -1676 removed lines

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

core/services/database/TableAnalysis.php

Indentation +118 added lines, -118 removed lines

@@ -18,129 +18,129 @@
 class TableAnalysis extends EE_Base
 {
 
-    /**
-     * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
-     * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
-     */
-    const INDEX_COLUMN_SIZE = 191;
+	/**
+	 * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
+	 * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
+	 */
+	const INDEX_COLUMN_SIZE = 191;
 
-    /**
-     * Returns the table name which will definitely have the wpdb prefix on the front,
-     * except if it currently has the wpdb->base_prefix on the front, in which case
-     * it will have the wpdb->base_prefix on it
-     *
-     * @global wpdb $wpdb
-     * @param string $table_name
-     * @return string $tableName, having ensured it has the wpdb prefix on the front
-     */
-    public function ensureTableNameHasPrefix($table_name)
-    {
-        global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
-    }
+	/**
+	 * Returns the table name which will definitely have the wpdb prefix on the front,
+	 * except if it currently has the wpdb->base_prefix on the front, in which case
+	 * it will have the wpdb->base_prefix on it
+	 *
+	 * @global wpdb $wpdb
+	 * @param string $table_name
+	 * @return string $tableName, having ensured it has the wpdb prefix on the front
+	 */
+	public function ensureTableNameHasPrefix($table_name)
+	{
+		global $wpdb;
+		return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+	}
 
 
-    /**
-     * Indicates whether or not the table has any entries. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global wpdb $wpdb
-     * @param string $table_name
-     * @return bool
-     */
-    public function tableIsEmpty($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        if ($this->tableExists($table_name)) {
-            $count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
-            return absint($count) === 0;
-        }
-        return false;
-    }
+	/**
+	 * Indicates whether or not the table has any entries. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global wpdb $wpdb
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public function tableIsEmpty($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		if ($this->tableExists($table_name)) {
+			$count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
+			return absint($count) === 0;
+		}
+		return false;
+	}
 
 
-    /**
-     * Indicates whether or not the table exists. $table_name can optionally
-     * have the $wpdb->prefix on the beginning, or not.
-     *
-     * @global wpdb $wpdb
-     * @param string $table_name
-     * @return bool
-     */
-    public function tableExists($table_name)
-    {
-        global $wpdb, $EZSQL_ERROR;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        // ignore if this causes an sql error
-        $prev_last_error      = $wpdb->last_error;
-        $prev_EZSQL_ERROR     = $EZSQL_ERROR;
-        $prev_suppress_errors = $wpdb->suppress_errors();
-        $prev_show_errors     = $wpdb->hide_errors();
-        ob_start();
-        $wpdb->get_results("SELECT COUNT(*) from $table_name LIMIT 1");
-        ob_get_clean();
-        // grab any new errors that were just generated
-        $new_error        = $wpdb->last_error;
-        // reset error handling values to previous state
-        $wpdb->last_error = $prev_last_error;
-        $EZSQL_ERROR      = $prev_EZSQL_ERROR;
-        $wpdb->show_errors($prev_show_errors);
-        $wpdb->suppress_errors($prev_suppress_errors);
-        // if there was no "table doesn't exist" error then the table must exist
-        if (empty($new_error)) {
-            return true;
-        }
-        $error_codes = [
-            1051, // bad table
-            1109, // unknown table
-            117, // no such table
-        ];
-        if (in_array(EEH_Activation::last_wpdb_error_code(), $error_codes)
-            // in case not using mysql and error codes aren't reliable, just check for this error string
-            || preg_match('~^Table .* doesn\'t exist~', $new_error)
-        ) {
-            return false;
-        }
-        // log this because that's weird. Just use the normal PHP error log
-        error_log(
-            sprintf(
-                __(
-                    'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
-                    'event_espresso'
-                ),
-                $new_error
-            )
-        );
-        return false;
-    }
+	/**
+	 * Indicates whether or not the table exists. $table_name can optionally
+	 * have the $wpdb->prefix on the beginning, or not.
+	 *
+	 * @global wpdb $wpdb
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public function tableExists($table_name)
+	{
+		global $wpdb, $EZSQL_ERROR;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		// ignore if this causes an sql error
+		$prev_last_error      = $wpdb->last_error;
+		$prev_EZSQL_ERROR     = $EZSQL_ERROR;
+		$prev_suppress_errors = $wpdb->suppress_errors();
+		$prev_show_errors     = $wpdb->hide_errors();
+		ob_start();
+		$wpdb->get_results("SELECT COUNT(*) from $table_name LIMIT 1");
+		ob_get_clean();
+		// grab any new errors that were just generated
+		$new_error        = $wpdb->last_error;
+		// reset error handling values to previous state
+		$wpdb->last_error = $prev_last_error;
+		$EZSQL_ERROR      = $prev_EZSQL_ERROR;
+		$wpdb->show_errors($prev_show_errors);
+		$wpdb->suppress_errors($prev_suppress_errors);
+		// if there was no "table doesn't exist" error then the table must exist
+		if (empty($new_error)) {
+			return true;
+		}
+		$error_codes = [
+			1051, // bad table
+			1109, // unknown table
+			117, // no such table
+		];
+		if (in_array(EEH_Activation::last_wpdb_error_code(), $error_codes)
+			// in case not using mysql and error codes aren't reliable, just check for this error string
+			|| preg_match('~^Table .* doesn\'t exist~', $new_error)
+		) {
+			return false;
+		}
+		// log this because that's weird. Just use the normal PHP error log
+		error_log(
+			sprintf(
+				__(
+					'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
+					'event_espresso'
+				),
+				$new_error
+			)
+		);
+		return false;
+	}
 
 
-    /**
-     * @param string $table_name
-     * @param string $index_name
-     * @return array of columns used on that index, Each entry is an object with the following properties {
-     * @type string Table
-     * @type string Non_unique "0" or "1"
-     * @type string Key_name
-     * @type string Seq_in_index
-     * @type string Column_name
-     * @type string Collation
-     * @type string Cardinality
-     * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
-     *       indexing
-     * @type string|null Packed
-     * @type string Null
-     * @type string Index_type
-     * @type string Comment
-     * @type string Index_comment
-     * }
-     */
-    public function showIndexes($table_name, $index_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
-        return $wpdb->get_results($index_exists_query);
-    }
+	/**
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return array of columns used on that index, Each entry is an object with the following properties {
+	 * @type string Table
+	 * @type string Non_unique "0" or "1"
+	 * @type string Key_name
+	 * @type string Seq_in_index
+	 * @type string Column_name
+	 * @type string Collation
+	 * @type string Cardinality
+	 * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
+	 *       indexing
+	 * @type string|null Packed
+	 * @type string Null
+	 * @type string Index_type
+	 * @type string Comment
+	 * @type string Index_comment
+	 * }
+	 */
+	public function showIndexes($table_name, $index_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
+		return $wpdb->get_results($index_exists_query);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     public function ensureTableNameHasPrefix($table_name)
     {
         global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix.$table_name;
     }
 
 

core/services/database/TableManager.php

Spacing +8 added lines, -8 removed lines

@@ -70,7 +70,7 @@ 
         global $wpdb;
         $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
+        if ( ! in_array($column_name, $columns)) {
             $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
             return $wpdb->query($alter_query);
         }
@@ -93,7 +93,7 @@ 
         global $wpdb;
         $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $field_array = array();
-        if (! empty($table_name)) {
+        if ( ! empty($table_name)) {
             $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
             if ($columns !== false) {
                 foreach ($columns as $column) {
@@ -143,14 +143,14 @@ 
         foreach ($table_names as $table_name) {
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
+                $tables_to_delete[$table_name] = $table_name;
             }
         }
-        if (! empty($tables_to_delete)) {
+        if ( ! empty($tables_to_delete)) {
             global $wpdb;
             // make sure we only have a unique strings in the array.
             $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         }
         return $tables_to_delete;
     }
@@ -199,7 +199,7 @@ 
     {
         // does $sql contain valid column information?
         // LPT: https://regex101.com/ is great for working out regex patterns
-        if (! preg_match('(((.*?)(,\s))+)', $create_sql, $valid_column_data)) {
+        if ( ! preg_match('(((.*?)(,\s))+)', $create_sql, $valid_column_data)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -235,7 +235,7 @@ 
         $output = ob_get_clean();
         $wpdb->show_errors($old_show_errors_policy);
         $wpdb->suppress_errors($old_error_suppression_policy);
-        if (! empty($output)) {
+        if ( ! empty($output)) {
             throw new EE_Error($output);
         }
     }
@@ -264,7 +264,7 @@ 
         if ($column_name === null) {
             $column_name = $index_name;
         }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
+        if ( ! $this->getTableAnalysis()->tableExists($table_name)) {
             return false;
         }
         $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);

Indentation +236 added lines, -236 removed lines

@@ -16,258 +16,258 @@
 class TableManager extends \EE_Base
 {
 
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     * @throws EE_Error
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 * @throws EE_Error
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return array
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return array
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return int
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return int
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @param array $table_names
-     * @return array of table names which we deleted
-     * @throws EE_Error
-     * @global WPDB $wpdb
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 * @throws EE_Error
+	 * @global WPDB $wpdb
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $index_name
-     * @return int the number of indexes dropped. False if there was a database error
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
-        if ($this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query) === $table_name
-            // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int the number of indexes dropped. False if there was a database error
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
+		if ($this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query) === $table_name
+			// using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        // does $sql contain valid column information?
-        // LPT: https://regex101.com/ is great for working out regex patterns
-        if (! preg_match('(((.*?)(,\s))+)', $create_sql, $valid_column_data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        global $wpdb;
-        $collation = $wpdb->get_charset_collate();
-        $SQL = "CREATE TABLE {$table_name} ({$create_sql}) ENGINE={$engine} {$collation}";
-        // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-        // happened. And then we can choose to tell the end user
-        $old_show_errors_policy = $wpdb->show_errors(true);
-        $old_error_suppression_policy = $wpdb->suppress_errors(false);
-        ob_start();
-        dbDelta($SQL);
-        $output = ob_get_clean();
-        $wpdb->show_errors($old_show_errors_policy);
-        $wpdb->suppress_errors($old_error_suppression_policy);
-        if (! empty($output)) {
-            throw new EE_Error($output);
-        }
-    }
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		// does $sql contain valid column information?
+		// LPT: https://regex101.com/ is great for working out regex patterns
+		if (! preg_match('(((.*?)(,\s))+)', $create_sql, $valid_column_data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		global $wpdb;
+		$collation = $wpdb->get_charset_collate();
+		$SQL = "CREATE TABLE {$table_name} ({$create_sql}) ENGINE={$engine} {$collation}";
+		// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+		// happened. And then we can choose to tell the end user
+		$old_show_errors_policy = $wpdb->show_errors(true);
+		$old_error_suppression_policy = $wpdb->suppress_errors(false);
+		ob_start();
+		dbDelta($SQL);
+		$output = ob_get_clean();
+		$wpdb->show_errors($old_show_errors_policy);
+		$wpdb->suppress_errors($old_error_suppression_policy);
+		if (! empty($output)) {
+			throw new EE_Error($output);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbDelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbDelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string|null $column_name       if none is provided, we assume the column name matches the index
-     *                                       (often true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        $table_name,
-        $index_name,
-        $column_name = null,
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === null) {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if ($column_name === $index_entry->Column_name
-                && (string) $desired_index_size !== $index_entry->Sub_part) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbDelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbDelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string|null $column_name       if none is provided, we assume the column name matches the index
+	 *                                       (often true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		$table_name,
+		$index_name,
+		$column_name = null,
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === null) {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if ($column_name === $index_entry->Column_name
+				&& (string) $desired_index_size !== $index_entry->Sub_part) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Spacing +117 added lines, -117 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']),
@@ -673,10 +673,10 @@ 
             // (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.
@@ -685,7 +685,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(
@@ -701,10 +701,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;
     }
@@ -717,13 +717,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);
             }
         }
@@ -740,26 +740,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'],
                 )
             );
         }
@@ -774,10 +774,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'])
             );
         }
     }
@@ -791,12 +791,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'],
                 )
             );
         }
@@ -810,10 +810,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'])
             );
         }
     }
@@ -826,10 +826,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'])
             );
         }
     }
@@ -842,17 +842,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(),
                 )
             );
@@ -867,10 +867,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'])
             );
         }
     }
@@ -883,12 +883,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'],
                 )
             );
         }
@@ -902,7 +902,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')
@@ -918,15 +918,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'],
                 )
             );
         }
@@ -944,10 +944,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'])
             );
         }
     }
@@ -964,10 +964,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']
             );
         }
     }
@@ -979,10 +979,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']
             );
         }
     }
@@ -994,10 +994,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']
             );
         }
     }
@@ -1015,11 +1015,11 @@ 
      */
     private static function _load_and_init_addon_class($addon_name)
     {
-        $addon_class = self::$_settings[ $addon_name ]['class_name'];
+        $addon_class = self::$_settings[$addon_name]['class_name'];
         $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
         $addon = $loader->getShared($addon_class, ['EE_Registry::create(addon)' => true]);
         // verify addon has been instantiated correctly
-        if (! $addon instanceof $addon_class) {
+        if ( ! $addon instanceof $addon_class) {
             throw new DomainException(
                 sprintf(
                     __(
@@ -1041,19 +1041,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']
                         ),
                     )
                 );
@@ -1063,28 +1063,28 @@ 
             }
         }
         $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']);
         // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+        if ( ! empty(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug'])) {
+            $addon->setPueSlug(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug']);
         }
         // 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;
@@ -1102,11 +1102,11 @@ 
     public static function load_pue_update()
     {
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue/pue-client.php';
+        require_once EE_THIRD_PARTY.'pue/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
@@ -1114,7 +1114,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(
@@ -1143,7 +1143,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);
                 }
@@ -1165,70 +1165,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(
@@ -1251,7 +1251,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);
         }
     }

Indentation +1174 added lines, -1174 removed lines

@@ -22,1238 +22,1238 @@
 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 DomainException
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $addon_class = self::$_settings[ $addon_name ]['class_name'];
-        $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
-        $addon = $loader->getShared($addon_class, ['EE_Registry::create(addon)' => true]);
-        // verify addon has been instantiated correctly
-        if (! $addon instanceof $addon_class) {
-            throw new DomainException(
-                sprintf(
-                    __(
-                        'An attempt to register an EE_Addon named "%1$s" has failed because the "%2$s" class is either missing or invalid. The following was created instead: %3$s',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $addon_class,
-                    print_r($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']);
-        // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
-        }
-        // 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 DomainException
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$addon_class = self::$_settings[ $addon_name ]['class_name'];
+		$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
+		$addon = $loader->getShared($addon_class, ['EE_Registry::create(addon)' => true]);
+		// verify addon has been instantiated correctly
+		if (! $addon instanceof $addon_class) {
+			throw new DomainException(
+				sprintf(
+					__(
+						'An attempt to register an EE_Addon named "%1$s" has failed because the "%2$s" class is either missing or invalid. The following was created instead: %3$s',
+						'event_espresso'
+					),
+					$addon_name,
+					$addon_class,
+					print_r($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']);
+		// setup the add-on's pue_slug if we have one.
+		if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
+			$addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+		}
+		// 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/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/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);
+		}
+	}
 }

core/EE_System.core.php

Indentation +1308 added lines, -1308 removed lines

@@ -27,1312 +27,1312 @@
 final class EE_System implements ResettableInterface
 {
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null    $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadRouteMatchSpecifications')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (($this->request->isWordPressApi() || $this->request->isApi())
-            && $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_activation_or_upgrade();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            // it exists, so this isn't a completely new install
-            // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                // it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    // we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            // brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        // find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                // check there is a record of when this version was activated. Otherwise,
-                // mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     */
-    private function _maybe_brew_regular()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            array(
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version()),
-            )
-        );
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @throws Exception
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
-            try {
-                // load, register, and add shortcodes the new way
-                $this->loader->getShared(
-                    'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                    array(
-                        // and the old way, but we'll put it under control of the new system
-                        EE_Config::getLegacyShortcodesManager(),
-                    )
-                );
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = __(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
-        $register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $register_custom_taxonomies->registerCustomTaxonomies();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
-        $register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $register_custom_post_types->registerCustomPostTypes();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
-        $register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        $register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        } elseif ($this->request->isWordPressHeartbeat()) {
-            $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        if ($this->request->isAdmin()
-            || $this->request->isFrontend()
-            || $this->request->isIframe()
-            || $this->request->isWordPressApi()
-        ) {
-            try {
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-                $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
-                if ($this->canLoadBlocks()) {
-                    $this->loader->getShared(
-                        'EventEspresso\core\services\editor\BlockRegistrationManager'
-                    );
-                }
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        if ($this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-        if (($this->request->isAjax() || $this->request->isAdmin())
-            && $this->maintenance_mode->models_can_query()) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
-            $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     * @return bool
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null    $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadRouteMatchSpecifications')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (($this->request->isWordPressApi() || $this->request->isApi())
+			&& $this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_activation_or_upgrade();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[ $version_string ] = array('unknown-date');
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			// it exists, so this isn't a completely new install
+			// check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				// it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					// we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			// brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		// find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				// check there is a record of when this version was activated. Otherwise,
+				// mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 */
+	private function _maybe_brew_regular()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			array(
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version()),
+			)
+		);
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @throws Exception
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
+			try {
+				// load, register, and add shortcodes the new way
+				$this->loader->getShared(
+					'EventEspresso\core\services\shortcodes\ShortcodesManager',
+					array(
+						// and the old way, but we'll put it under control of the new system
+						EE_Config::getLegacyShortcodesManager(),
+					)
+				);
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = __(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
+		$register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$register_custom_taxonomies->registerCustomTaxonomies();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
+		$register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$register_custom_post_types->registerCustomPostTypes();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
+		$register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		$register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		} elseif ($this->request->isWordPressHeartbeat()) {
+			$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		if ($this->request->isAdmin()
+			|| $this->request->isFrontend()
+			|| $this->request->isIframe()
+			|| $this->request->isWordPressApi()
+		) {
+			try {
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+				$this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
+				if ($this->canLoadBlocks()) {
+					$this->loader->getShared(
+						'EventEspresso\core\services\editor\BlockRegistrationManager'
+					);
+				}
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		if ($this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+		if (($this->request->isAjax() || $this->request->isAdmin())
+			&& $this->maintenance_mode->models_can_query()) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
+			$this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 * @return bool
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }