eventespresso / event-espresso-core

core/db_models/relations/EE_HABTM_Relation.php

Spacing +18 added lines, -18 removed lines

@@ -65,18 +65,18 @@ 
         // remember the model relation chain to the JOIN model, because we'll
         // need it for get_join_statement()
         $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
+        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field(); // get_foreign_key_to($this->get_other_model()->get_this_model_name());
         $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
         $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $model_relation_chain,
             $this->get_this_model()->get_this_model_name()
-        ) . $this_table_pk_field->get_table_alias();
+        ).$this_table_pk_field->get_table_alias();
 
         $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $model_relation_chain,
             $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
+        ).$join_table_fk_field_to_this_table->get_table_alias();
+        $join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
         // phew! ok, we have all the info we need, now we can create the SQL join string
         $SQL = $this->_left_join(
             $join_table,
@@ -84,7 +84,7 @@ 
             $join_table_fk_field_to_this_table->get_table_column(),
             $this_table_alias,
             $this_table_pk_field->get_table_column()
-        ) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+        ).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
         return $SQL;
     }
@@ -113,14 +113,14 @@ 
         $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $this->_model_relation_chain_to_join_model,
             $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
+        ).$join_table_fk_field_to_this_table->get_table_alias();
         $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
         $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
         $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $model_relation_chain,
             $this->get_other_model()->get_this_model_name()
-        ) . $other_table_pk_field->get_table_alias();
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
+        ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
         $SQL = $this->_left_join(
             $other_table,
@@ -128,7 +128,7 @@ 
             $other_table_pk_field->get_table_column(),
             $join_table_alias,
             $join_table_fk_field_to_other_table->get_table_column()
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+        ).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
         return $SQL;
     }
 
@@ -161,17 +161,17 @@ 
         );
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
+        if ( ! empty($extra_join_model_fields_n_values)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $all_fields = array_merge($foreign_keys, $parsed_query);
         }
@@ -181,7 +181,7 @@ 
         // new row.
         // Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
         // the other tables) use the joining model directly!
-        if (! $existing_entry_in_join_table) {
+        if ( ! $existing_entry_in_join_table) {
             $this->get_join_model()->insert($all_fields);
         } else {
             $this->get_join_model()->update(
@@ -217,17 +217,17 @@ 
         );
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
+        if ( ! empty($where_query)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $cols_n_values = array_merge($cols_n_values, $parsed_query);
         }

Indentation +239 added lines, -239 removed lines

@@ -9,266 +9,266 @@
  */
 class EE_HABTM_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
-     * which joins EE_Event and EE_Question_Group
-     *
-     * @var EEM_Base
-     */
-    protected $_joining_model_name;
+	/**
+	 * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
+	 * which joins EE_Event and EE_Question_Group
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_joining_model_name;
 
-    protected $_model_relation_chain_to_join_model;
+	protected $_model_relation_chain_to_join_model;
 
 
-    /**
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
-     * (and an ee joining-model.) This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool    $joining_model_name
-     * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
-     *                                               are related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
-    {
-        $this->_joining_model_name = $joining_model_name;
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool    $joining_model_name
+	 * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
+	 *                                               are related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
+	{
+		$this->_joining_model_name = $joining_model_name;
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
-    /**
-     * Gets the joining model's object
-     *
-     * @return EEM_Base
-     */
-    public function get_join_model()
-    {
-        return $this->_get_model($this->_joining_model_name);
-    }
+	/**
+	 * Gets the joining model's object
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_join_model()
+	{
+		return $this->_get_model($this->_joining_model_name);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_to_intermediate_model_statement($model_relation_chain)
-    {
-        // create sql like
-        // LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
-        // LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
-        // remember the model relation chain to the JOIN model, because we'll
-        // need it for get_join_statement()
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_this_model()->get_this_model_name()
-        ) . $this_table_pk_field->get_table_alias();
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_to_intermediate_model_statement($model_relation_chain)
+	{
+		// create sql like
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		// remember the model relation chain to the JOIN model, because we'll
+		// need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_this_model()->get_this_model_name()
+		) . $this_table_pk_field->get_table_alias();
 
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
-        // phew! ok, we have all the info we need, now we can create the SQL join string
-        $SQL = $this->_left_join(
-            $join_table,
-            $join_table_alias,
-            $join_table_fk_field_to_this_table->get_table_column(),
-            $this_table_alias,
-            $this_table_pk_field->get_table_column()
-        ) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_join_model()->get_this_model_name()
+		) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
+		// phew! ok, we have all the info we need, now we can create the SQL join string
+		$SQL = $this->_left_join(
+			$join_table,
+			$join_table_alias,
+			$join_table_fk_field_to_this_table->get_table_column(),
+			$this_table_alias,
+			$this_table_pk_field->get_table_column()
+		) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
-        return $SQL;
-    }
+		return $SQL;
+	}
 
 
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        if ($this->_model_relation_chain_to_join_model === null) {
-            throw new EE_Error(sprintf(__(
-                'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                'event_espresso'
-            )));
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $this->_model_relation_chain_to_join_model,
-            $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
-        $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_other_model()->get_this_model_name()
-        ) . $other_table_pk_field->get_table_alias();
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
+	/**
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
+	 * the intermediate join table, and then to the other model's pk's table
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		if ($this->_model_relation_chain_to_join_model === null) {
+			throw new EE_Error(sprintf(__(
+				'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
+				'event_espresso'
+			)));
+		}
+		$join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$this->_model_relation_chain_to_join_model,
+			$this->get_join_model()->get_this_model_name()
+		) . $join_table_fk_field_to_this_table->get_table_alias();
+		$other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
+		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_other_model()->get_this_model_name()
+		) . $other_table_pk_field->get_table_alias();
+		$other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-        $SQL = $this->_left_join(
-            $other_table,
-            $other_table_alias,
-            $other_table_pk_field->get_table_column(),
-            $join_table_alias,
-            $join_table_fk_field_to_other_table->get_table_column()
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-        return $SQL;
-    }
+		$SQL = $this->_left_join(
+			$other_table,
+			$other_table_alias,
+			$other_table_pk_field->get_table_column(),
+			$join_table_alias,
+			$join_table_fk_field_to_other_table->get_table_column()
+		) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		return $SQL;
+	}
 
 
-    /**
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
-     * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
-     * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
-     * columns' values
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
-     *                                                            checking existing values and for setting new rows if
-     *                                                            no exact matches.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
+	 * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
+	 * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
+	 * columns' values
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
+	 *                                                            checking existing values and for setting new rows if
+	 *                                                            no exact matches.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $foreign_keys = $all_fields = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
+		$foreign_keys = $all_fields = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $all_fields = array_merge($foreign_keys, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($extra_join_model_fields_n_values)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param                = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$all_fields = array_merge($foreign_keys, $parsed_query);
+		}
 
-        $existing_entry_in_join_table = $this->get_join_model()->get_one(array($foreign_keys));
-        // If there is already an entry in the join table, indicating a relationship, update it instead of adding a
-        // new row.
-        // Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
-        // the other tables) use the joining model directly!
-        if (! $existing_entry_in_join_table) {
-            $this->get_join_model()->insert($all_fields);
-        } else {
-            $this->get_join_model()->update(
-                $all_fields,
-                [$foreign_keys]
-            );
-        }
-        return $other_model_obj;
-    }
+		$existing_entry_in_join_table = $this->get_join_model()->get_one(array($foreign_keys));
+		// If there is already an entry in the join table, indicating a relationship, update it instead of adding a
+		// new row.
+		// Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
+		// the other tables) use the joining model directly!
+		if (! $existing_entry_in_join_table) {
+			$this->get_join_model()->insert($all_fields);
+		} else {
+			$this->get_join_model()->update(
+				$all_fields,
+				[$foreign_keys]
+			);
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
-     *                                       values and for removing existing rows if exact matches exist.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($where_query as $query_param => $val) {
+				$query_param                = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $this->get_join_model()->delete(array($cols_n_values));
-        return $other_model_obj;
-    }
+		$this->get_join_model()->delete(array($cols_n_values));
+		return $other_model_obj;
+	}
 
-    /**
-     * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
-     * @since 4.9.76.p
-     * @return EE_Model_Field_Base[]
-     * @throws EE_Error
-     */
-    public function getNonKeyFields()
-    {
-        // all fields besides the primary key and two foreign keys should be parameters
-        $join_model = $this->get_join_model();
-        $standard_fields = array();
-        if ($join_model->has_primary_key_field()) {
-            $standard_fields[] = $join_model->primary_key_name();
-        }
-        if ($this->get_this_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_this_model()->primary_key_name();
-        }
-        if ($this->get_other_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_other_model()->primary_key_name();
-        }
-        return array_diff_key(
-            $join_model->field_settings(),
-            array_flip($standard_fields)
-        );
-    }
+	/**
+	 * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
+	 * @since 4.9.76.p
+	 * @return EE_Model_Field_Base[]
+	 * @throws EE_Error
+	 */
+	public function getNonKeyFields()
+	{
+		// all fields besides the primary key and two foreign keys should be parameters
+		$join_model = $this->get_join_model();
+		$standard_fields = array();
+		if ($join_model->has_primary_key_field()) {
+			$standard_fields[] = $join_model->primary_key_name();
+		}
+		if ($this->get_this_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_this_model()->primary_key_name();
+		}
+		if ($this->get_other_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_other_model()->primary_key_name();
+		}
+		return array_diff_key(
+			$join_model->field_settings(),
+			array_flip($standard_fields)
+		);
+	}
 
-    /**
-     * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
-     * @since 4.9.76.p
-     * @return boolean
-     */
-    public function hasNonKeyFields()
-    {
-        return count($this->get_join_model()->field_settings()) > 3;
-    }
+	/**
+	 * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
+	 * @since 4.9.76.p
+	 * @return boolean
+	 */
+	public function hasNonKeyFields()
+	{
+		return count($this->get_join_model()->field_settings()) > 3;
+	}
 }

core/EE_Data_Migration_Manager.core.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\interfaces\ResettableInterface;
-
 use EventEspresso\core\services\database\TableManager;
 use EventEspresso\core\services\database\TableAnalysis;
 use EventEspresso\core\services\loaders\LoaderFactory;

Spacing +61 added lines, -61 removed lines

@@ -158,7 +158,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+        if ( ! self::$_instance instanceof EE_Data_Migration_Manager) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -234,12 +234,12 @@ 
 
         if (count($parts) == 4) {
             // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug = $parts[0];// eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+            $plugin_slug = $parts[0]; // eg Core
+            $version_string = $parts[1].".".$parts[2].".".$parts[3]; // eg 4.1.0
         } else {
             // it's 4.1-style: eg 4.1.0
             $plugin_slug = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
+            $version_string = $plugin_slug_and_version_string; // eg 4.1.0
         }
         return array($plugin_slug, $version_string);
     }
@@ -291,11 +291,11 @@ 
      */
     public function get_data_migrations_ran()
     {
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             // setup autoloaders for each of the scripts in there
             $this->get_all_data_migration_scripts_available();
             $data_migrations_options = $this->get_all_migration_script_options(
-            );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+            ); // get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
 
             $data_migrations_ran = array();
             // convert into data migration script classes where possible
@@ -309,23 +309,23 @@ 
                         $data_migration_option['option_name'],
                         $data_migration_option['option_value']
                     );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+                    $data_migrations_ran[$plugin_slug][$version_string] = $class;
                     // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
                     $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
+                    if ( ! $class->is_completed()) {
                         // sometimes we also like to know which was the last incomplete script (or if there are any at all)
                         $this->_last_ran_incomplete_script = $class;
                     }
                 } catch (EE_Error $e) {
                     // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+                    $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize(
                         $data_migration_option['option_value']
                     );
                 }
             }
             // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
             $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+            if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
                 $this->_data_migrations_ran = array();
             }
         }
@@ -358,7 +358,7 @@ 
     {
         global $wpdb;
         return $wpdb->get_results(
-            "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
+            "SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC",
             ARRAY_A
         );
     }
@@ -373,7 +373,7 @@ 
     {
         return apply_filters(
             'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('Core' => EE_CORE . 'data_migration_scripts')
+            array('Core' => EE_CORE.'data_migration_scripts')
         );
     }
 
@@ -389,15 +389,15 @@ 
      */
     public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
     {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
+        if (isset($this->script_migration_versions[$migration_script_name])) {
+            return $this->script_migration_versions[$migration_script_name];
         }
         $dms_info = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = array(
+        $this->script_migration_versions[$migration_script_name] = array(
             'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
-            'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
+            'version' => $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'],
         );
-        return $this->script_migration_versions[ $migration_script_name ];
+        return $this->script_migration_versions[$migration_script_name];
     }
 
     /**
@@ -411,7 +411,7 @@ 
     {
         $matches = array();
         preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+        if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -442,7 +442,7 @@ 
     {
         $espresso_db_core_updates = get_option('espresso_db_update', array());
         $db_state = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
+        if ( ! $db_state) {
             // mark the DB as being in the state as the last version in there.
             // this is done to trigger maintenance mode and do data migration scripts
             // if the admin installed this version of EE over 3.1.x or 4.0.x
@@ -461,7 +461,7 @@ 
         // in 4.1, $db_state would have only been a simple string like '4.1.0',
         // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
         // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
+        if ( ! is_array($db_state)) {
             $db_state = array('Core' => $db_state);
             update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
         }
@@ -498,29 +498,29 @@ 
                 $script_converts_plugin_slug = $migrates_to_version['slug'];
                 $script_converts_to_version = $migrates_to_version['version'];
                 // check if this version script is DONE or not; or if it's never been ran
-                if (! $scripts_ran ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
+                if ( ! $scripts_ran ||
+                    ! isset($scripts_ran[$script_converts_plugin_slug]) ||
+                    ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])) {
                     // we haven't ran this conversion script before
                     // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
                     $script = LoaderFactory::getLoader()->load($classname);
                     /* @var $script EE_Data_Migration_Script_Base */
                     $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
                     if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version'];
+                        unset($script_class_and_filepaths_available[$classname]);
                     }
-                } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
+                } elseif ($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base) {
                     // this script has been ran, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+                    $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version];
                     if ($script->get_status() != self::status_completed) {
                         // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version'];
+                        unset($script_class_and_filepaths_available[$classname]);
                     } else {
                         // it must have a status that indicates it has finished, so we don't want to try and run it again
                     }
@@ -531,14 +531,14 @@ 
                 }
             }
             $iteration++;
-        } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
+        }while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
         // ok we have all the scripts that should run, now let's make them into flat array
         $scripts_that_should_run = array();
         foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
             ksort($scripts_at_priority);
             foreach ($scripts_at_priority as $scripts) {
                 foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
+                    $scripts_that_should_run[get_class($script)] = $script;
                 }
             }
         }
@@ -563,7 +563,7 @@ 
     public function get_last_ran_script($include_completed_scripts = false)
     {
         // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             $this->get_data_migrations_ran();
         }
         if ($include_completed_scripts) {
@@ -600,10 +600,10 @@ 
 
         try {
             $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
+            if ( ! $currently_executing_script) {
                 // Find the next script that needs to execute
                 $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
+                if ( ! $scripts) {
                     // huh, no more scripts to run... apparently we're done!
                     // but dont forget to make sure initial data is there
                     // we should be good to allow them to exit maintenance mode now
@@ -629,7 +629,7 @@ 
                 $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
                 $plugin_slug = $migrates_to['slug'];
                 $version = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+                $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script;
             }
             $current_script_name = get_class($currently_executing_script);
         } catch (Exception $e) {
@@ -637,7 +637,7 @@ 
 
             $message = sprintf(
                 __("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
+                $e->getMessage().'<br>',
                 $e->getTraceAsString()
             );
             // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
@@ -689,7 +689,7 @@ 
                     );
                     // check if there are any more after this one.
                     $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
+                    if ( ! $scripts_remaining) {
                         // we should be good to allow them to exit maintenance mode now
                         EE_Maintenance_Mode::instance()->set_maintenance_level(
                             intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
@@ -789,7 +789,7 @@ 
                 ),
                 'script'             => 'Unknown',
             );
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+            $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString());
         }
         $warnings_etc = @ob_get_contents();
         ob_end_clean();
@@ -809,12 +809,12 @@ 
      */
     public function update_current_database_state_to($slug_and_version = null)
     {
-        if (! $slug_and_version) {
+        if ( ! $slug_and_version) {
             // no version was provided, assume it should be at the current code version
             $slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
         }
         $current_database_state = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+        $current_database_state[$slug_and_version['slug']] = $slug_and_version['version'];
         update_option(self::current_database_state, $current_database_state);
     }
 
@@ -833,15 +833,15 @@ 
         $slug = $slug_and_version['slug'];
         $version = $slug_and_version['version'];
         $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
+        if ( ! isset($current_database_state[$slug])) {
             return true;
         } else {
             // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[$slug]), 0, 3);
             $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
             $needs_updating = false;
             foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) {
                     $needs_updating = true;
                     break;
                 }
@@ -863,7 +863,7 @@ 
      */
     public function get_all_data_migration_scripts_available()
     {
-        if (! $this->_data_migration_class_to_filepath_map) {
+        if ( ! $this->_data_migration_class_to_filepath_map) {
             $this->_data_migration_class_to_filepath_map = array();
             foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
                 // strip any placeholders added to classname to make it a unique array key
@@ -872,7 +872,7 @@ 
                     ? $eeAddonClass
                     : '';
                 $folder_path = EEH_File::end_with_directory_separator($folder_path);
-                $files = glob($folder_path . '*.dms.php');
+                $files = glob($folder_path.'*.dms.php');
                 if (empty($files)) {
                     continue;
                 }
@@ -898,7 +898,7 @@ 
                             '4.3.0.alpha.019'
                         );
                     }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+                    $this->_data_migration_class_to_filepath_map[$classname] = $file;
                 }
             }
             EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
@@ -930,7 +930,7 @@ 
         // get last-ran migration script
         global $wpdb;
         $last_migration_script_option = $wpdb->get_row(
-            "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
+            "SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1",
             ARRAY_A
         );
 
@@ -962,10 +962,10 @@ 
             $versions_migrated_to = 'Unknown.1.0.0';
             // now just to make sure appears as last (in case the were previously a fatal error like this)
             // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+            delete_option(self::data_migration_script_option_prefix.$versions_migrated_to);
         }
         update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
+            self::data_migration_script_option_prefix.$versions_migrated_to,
             $last_ran_migration_script_properties
         );
     }
@@ -984,8 +984,8 @@ 
         $successful_updates = true;
         foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
             foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
-                $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+                $plugin_slug_for_use_in_option_name = $plugin_slug.".";
+                $option_name = self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string;
                 $old_option_value = get_option($option_name);
                 if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
                     $script_array_for_saving = $array_or_migration_obj->properties_as_array();
@@ -997,7 +997,7 @@ 
                         $successful_updates = update_option($option_name, $array_or_migration_obj);
                     }
                 }
-                if (! $successful_updates) {
+                if ( ! $successful_updates) {
                     global $wpdb;
                     return $wpdb->last_error;
                 }
@@ -1031,7 +1031,7 @@ 
      */
     public function _instantiate_script_from_properties_array($properties_array)
     {
-        if (! isset($properties_array['class'])) {
+        if ( ! isset($properties_array['class'])) {
             throw new EE_Error(
                 sprintf(
                     __("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
@@ -1040,11 +1040,11 @@ 
             );
         }
         $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
         }
         $class = new $class_name;
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
+        if ( ! $class instanceof EE_Data_Migration_Script_Base) {
             throw new EE_Error(
                 sprintf(
                     __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
@@ -1111,8 +1111,8 @@ 
     public function get_migration_ran($version, $plugin_slug = 'Core')
     {
         $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
+        if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) {
+            return $migrations_ran[$plugin_slug][$version];
         } else {
             return null;
         }
@@ -1173,7 +1173,7 @@ 
     public function enqueue_db_initialization_for($plugin_slug)
     {
         $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
+        if ( ! in_array($plugin_slug, $queue)) {
             $queue[] = $plugin_slug;
         }
         update_option(self::db_init_queue_option_name, $queue);
@@ -1189,7 +1189,7 @@ 
         $queue = $this->get_db_initialization_queue();
         foreach ($queue as $plugin_slug) {
             $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
+            if ( ! $most_up_to_date_dms) {
                 // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
                 $verify_db = false;
             } else {

Indentation +1234 added lines, -1234 removed lines

@@ -33,1238 +33,1238 @@
 class EE_Data_Migration_Manager implements ResettableInterface
 {
 
-    /**
-     *
-     * @var EE_Registry
-     */
-    // protected $EE;
-    /**
-     * name of the wordpress option which stores an array of data about
-     */
-    const data_migrations_option_name = 'ee_data_migration';
-
-
-    const data_migration_script_option_prefix = 'ee_data_migration_script_';
-
-    const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
-
-    /**
-     * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0,
-     * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
-     */
-    const current_database_state = 'ee_data_migration_current_db_state';
-
-    /**
-     * Special status string returned when we're positive there are no more data migration
-     * scripts that can be run.
-     */
-    const status_no_more_migration_scripts = 'no_more_migration_scripts';
-    /**
-     * string indicating the migration should continue
-     */
-    const status_continue = 'status_continue';
-    /**
-     * string indicating the migration has completed and should be ended
-     */
-    const status_completed = 'status_completed';
-    /**
-     * string indicating a fatal error occurred and the data migration should be completely aborted
-     */
-    const status_fatal_error = 'status_fatal_error';
-
-    /**
-     * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
-     * during migration)
-     */
-    const step_size = 50;
-
-    /**
-     * option name that stores the queue of ee plugins needing to have
-     * their data initialized (or re-initialized) once we are done migrations
-     */
-    const db_init_queue_option_name = 'ee_db_init_queue';
-    /**
-     * Array of information concerning data migrations that have ran in the history
-     * of this EE installation. Keys should be the name of the version the script upgraded to
-     *
-     * @var EE_Data_Migration_Script_Base[]
-     */
-    private $_data_migrations_ran = null;
-    /**
-     * The last ran script. It's nice to store this somewhere accessible, as its easiest
-     * to know which was the last run by which is the newest wp option; but in most of the code
-     * we just use the local $_data_migration_ran array, which organized the scripts differently
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_script = null;
-
-    /**
-     * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_incomplete_script = null;
-    /**
-     * array where keys are classnames, and values are filepaths of all the known migration scripts
-     *
-     * @var array
-     */
-    private $_data_migration_class_to_filepath_map;
-
-    /**
-     * the following 4 properties are fully set on construction.
-     * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
-     * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
-     * data migration script
-     *
-     * @var array
-     */
-    public $stati_that_indicate_to_continue_migrations = array();
-
-    public $stati_that_indicate_to_stop_migrations = array();
-
-    public $stati_that_indicate_to_continue_single_migration_script = array();
-
-    public $stati_that_indicate_to_stop_single_migration_script = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-    /**
-     * @var array $script_migration_versions
-     */
-    protected $script_migration_versions;
-
-    /**
-     * @var EE_Data_Migration_Manager $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Data_Migration_Manager instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
-     * all new usages of the singleton should be made with Classname::instance()) and returns it
-     *
-     * @return EE_Data_Migration_Manager
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * constructor
-     */
-    private function __construct()
-    {
-        $this->stati_that_indicate_to_continue_migrations = array(
-            self::status_continue,
-            self::status_completed,
-        );
-        $this->stati_that_indicate_to_stop_migrations = array(
-            self::status_fatal_error,
-            self::status_no_more_migration_scripts,
-        );
-        $this->stati_that_indicate_to_continue_single_migration_script = array(
-            self::status_continue,
-        );
-        $this->stati_that_indicate_to_stop_single_migration_script = array(
-            self::status_completed,
-            self::status_fatal_error
-            // note: status_no_more_migration_scripts doesn't apply
-        );
-        // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
-        // to be defined, because right now it doesn't get autoloaded on its own
-        EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true);
-        EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true);
-        $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-    }
-
-
-    /**
-     * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
-     * the option names are like, but generally they're like
-     * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
-     * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
-     * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg
-     * EE_DMS_Core_4_1_0.dms.php)
-     *
-     * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
-     * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of
-     *               that plugin (eg '4.1.0')
-     */
-    private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
-    {
-        $plugin_slug_and_version_string = str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $option_name
-        );
-        // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
-        $parts = explode(".", $plugin_slug_and_version_string);
-
-        if (count($parts) == 4) {
-            // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug = $parts[0];// eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
-        } else {
-            // it's 4.1-style: eg 4.1.0
-            $plugin_slug = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
-        }
-        return array($plugin_slug, $version_string);
-    }
-
-    /**
-     * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not
-     * for a known DMS class.
-     *
-     * @param string $dms_option_name
-     * @param string $dms_option_value (serialized)
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
-    {
-        $data_migration_data = maybe_unserialize($dms_option_value);
-        if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
-            $class = LoaderFactory::getLoader()->getShared($data_migration_data['class']);
-            if ($class instanceof EE_Data_Migration_Script_Base) {
-                $class->instantiate_from_array_of_properties($data_migration_data);
-                return $class;
-            } else {
-                // huh, so its an object but not a data migration script?? that shouldn't happen
-                // just leave it as an array (which will probably just get ignored)
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
-                            'event_espresso'
-                        ),
-                        $data_migration_data['class']
-                    )
-                );
-            }
-        } else {
-            // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
-            throw new EE_Error(
-                sprintf(__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name)
-            );
-        }
-    }
-
-    /**
-     * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last
-     * ran, and which was the last ran which hasn't finished yet
-     *
-     * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy
-     *               arrays in there - which should probably be ignored)
-     */
-    public function get_data_migrations_ran()
-    {
-        if (! $this->_data_migrations_ran) {
-            // setup autoloaders for each of the scripts in there
-            $this->get_all_data_migration_scripts_available();
-            $data_migrations_options = $this->get_all_migration_script_options(
-            );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
-
-            $data_migrations_ran = array();
-            // convert into data migration script classes where possible
-            foreach ($data_migrations_options as $data_migration_option) {
-                list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
-                    $data_migration_option['option_name']
-                );
-
-                try {
-                    $class = $this->_get_dms_class_from_wp_option(
-                        $data_migration_option['option_name'],
-                        $data_migration_option['option_value']
-                    );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
-                    // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
-                    $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
-                        // sometimes we also like to know which was the last incomplete script (or if there are any at all)
-                        $this->_last_ran_incomplete_script = $class;
-                    }
-                } catch (EE_Error $e) {
-                    // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
-                        $data_migration_option['option_value']
-                    );
-                }
-            }
-            // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
-            $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
-                $this->_data_migrations_ran = array();
-            }
-        }
-        return $this->_data_migrations_ran;
-    }
-
-
-    /**
-     *
-     * @param string $script_name eg 'DMS_Core_4_1_0'
-     * @param string $old_table   eg 'wp_events_detail'
-     * @param string $old_pk      eg 'wp_esp_posts'
-     * @param        $new_table
-     * @return mixed string or int
-     */
-    public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
-    {
-        $script = EE_Registry::instance()->load_dms($script_name);
-        $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
-        return $mapping;
-    }
-
-    /**
-     * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
-     * the last option returned in this array is the most-recently ran DMS option
-     *
-     * @return array
-     */
-    public function get_all_migration_script_options()
-    {
-        global $wpdb;
-        return $wpdb->get_results(
-            "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
-            ARRAY_A
-        );
-    }
-
-    /**
-     * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
-     *
-     * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
-     *               slashes at the end of the folder name.
-     */
-    public function get_data_migration_script_folders()
-    {
-        return apply_filters(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('Core' => EE_CORE . 'data_migration_scripts')
-        );
-    }
-
-    /**
-     * Gets the version the migration script upgrades to
-     *
-     * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
-     * @return array {
-     * @type string  $slug                  like 'Core','Calendar',etc
-     * @type string  $version               like 4.3.0
-     *                                      }
-     * @throws EE_Error
-     */
-    public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
-    {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
-        }
-        $dms_info = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = array(
-            'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
-            'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
-        );
-        return $this->script_migration_versions[ $migration_script_name ];
-    }
-
-    /**
-     * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
-     *
-     * @param string $classname
-     * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints)
-     * @throws EE_Error
-     */
-    public function parse_dms_classname($classname)
-    {
-        $matches = array();
-        preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        return array(
-            'slug'          => $matches[1],
-            'major_version' => intval($matches[2]),
-            'minor_version' => intval($matches[3]),
-            'micro_version' => intval($matches[4]),
-        );
-    }
-
-    /**
-     * Ensures that the option indicating the current DB version is set. This should only be
-     * a concern when activating EE for the first time, THEORETICALLY.
-     * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
-     * to 4.1.x.
-     *
-     * @return string of current db state
-     */
-    public function ensure_current_database_state_is_set()
-    {
-        $espresso_db_core_updates = get_option('espresso_db_update', array());
-        $db_state = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
-            // mark the DB as being in the state as the last version in there.
-            // this is done to trigger maintenance mode and do data migration scripts
-            // if the admin installed this version of EE over 3.1.x or 4.0.x
-            // otherwise, the normal maintenance mode code is fine
-            $previous_versions_installed = array_keys($espresso_db_core_updates);
-            $previous_version_installed = end($previous_versions_installed);
-            if (version_compare('4.1.0', $previous_version_installed)) {
-                // last installed version was less than 4.1
-                // so we want the data migrations to happen. SO, we're going to say the DB is at that state
-                $db_state = array('Core' => $previous_version_installed);
-            } else {
-                $db_state = array('Core' => EVENT_ESPRESSO_VERSION);
-            }
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        // in 4.1, $db_state would have only been a simple string like '4.1.0',
-        // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
-        // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
-            $db_state = array('Core' => $db_state);
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        return $db_state;
-    }
-
-    /**
-     * Checks if there are any data migration scripts that ought to be run. If found,
-     * returns the instantiated classes. If none are found (ie, they've all already been run
-     * or they don't apply), returns an empty array
-     *
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function check_for_applicable_data_migration_scripts()
-    {
-        // get the option describing what options have already run
-        $scripts_ran = $this->get_data_migrations_ran();
-        // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
-        $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
-
-
-        $current_database_state = $this->ensure_current_database_state_is_set();
-        // determine which have already been run
-        $script_classes_that_should_run_per_iteration = array();
-        $iteration = 0;
-        $next_database_state_to_consider = $current_database_state;
-        $theoretical_database_state = null;
-        do {
-            // the next state after the currently-considered one will start off looking the same as the current, but we may make additions...
-            $theoretical_database_state = $next_database_state_to_consider;
-            // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?)
-            foreach ($script_class_and_filepaths_available as $classname => $filepath) {
-                $migrates_to_version = $this->script_migrates_to_version($classname);
-                $script_converts_plugin_slug = $migrates_to_version['slug'];
-                $script_converts_to_version = $migrates_to_version['version'];
-                // check if this version script is DONE or not; or if it's never been ran
-                if (! $scripts_ran ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
-                    // we haven't ran this conversion script before
-                    // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
-                    $script = LoaderFactory::getLoader()->load($classname);
-                    /* @var $script EE_Data_Migration_Script_Base */
-                    $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
-                    if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    }
-                } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
-                    // this script has been ran, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
-                    if ($script->get_status() != self::status_completed) {
-                        // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    } else {
-                        // it must have a status that indicates it has finished, so we don't want to try and run it again
-                    }
-                } else {
-                    // it exists but it's not  a proper data migration script
-                    // maybe the script got renamed? or was simply removed from EE?
-                    // either way, its certainly not runnable!
-                }
-            }
-            $iteration++;
-        } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
-        // ok we have all the scripts that should run, now let's make them into flat array
-        $scripts_that_should_run = array();
-        foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
-            ksort($scripts_at_priority);
-            foreach ($scripts_at_priority as $scripts) {
-                foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
-                }
-            }
-        }
-
-        do_action(
-            'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
-            $scripts_that_should_run
-        );
-        return $scripts_that_should_run;
-    }
-
-
-    /**
-     * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE
-     * it will return the last ran script even if its complete.
-     * This means: if you want to find the currently-executing script, leave it as FALSE.
-     * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
-     *
-     * @param bool $include_completed_scripts
-     * @return EE_Data_Migration_Script_Base
-     */
-    public function get_last_ran_script($include_completed_scripts = false)
-    {
-        // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
-            $this->get_data_migrations_ran();
-        }
-        if ($include_completed_scripts) {
-            return $this->_last_ran_script;
-        } else {
-            return $this->_last_ran_incomplete_script;
-        }
-    }
-
-
-    /**
-     * Runs the data migration scripts (well, each request to this method calls one of the
-     * data migration scripts' migration_step() functions).
-     *
-     * @param int   $step_size
-     * @throws EE_Error
-     * @return array {
-     *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
-     *                                  //and the second item is a string describing what was done
-     * @type int    $records_to_migrate from the current migration script
-     * @type int    $records_migrated
-     * @type string $status             one of EE_Data_Migration_Manager::status_*
-     * @type string $script             verbose name of the current DMS
-     * @type string $message            string describing what was done during this step
-     *                                  }
-     */
-    public function migration_step($step_size = 0)
-    {
-
-        // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
-        if (class_exists('EE_CPT_Strategy')) {
-            remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5);
-        }
-
-        try {
-            $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
-                // Find the next script that needs to execute
-                $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
-                    // huh, no more scripts to run... apparently we're done!
-                    // but dont forget to make sure initial data is there
-                    // we should be good to allow them to exit maintenance mode now
-                    EE_Maintenance_Mode::instance()->set_maintenance_level(
-                        intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
-                    );
-                    // saving migrations ran should actually be unnecessary, but leaving in place just in case
-                    // remember this migration was finished (even if we timeout initing db for core and plugins)
-                    $this->_save_migrations_ran();
-                    // make sure DB was updated AFTER we've recorded the migration was done
-                    $this->initialize_db_for_enqueued_ee_plugins();
-                    return array(
-                        'records_to_migrate' => 1,
-                        'records_migrated'   => 1,
-                        'status'             => self::status_no_more_migration_scripts,
-                        'script'             => __("Data Migration Completed Successfully", "event_espresso"),
-                        'message'            => __("All done!", "event_espresso"),
-                    );
-                }
-                $currently_executing_script = array_shift($scripts);
-                // and add to the array/wp option showing the scripts ran
-
-                $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
-                $plugin_slug = $migrates_to['slug'];
-                $version = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
-            }
-            $current_script_name = get_class($currently_executing_script);
-        } catch (Exception $e) {
-            // an exception occurred while trying to get migration scripts
-
-            $message = sprintf(
-                __("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
-                $e->getTraceAsString()
-            );
-            // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
-            // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
-            $this->add_error_to_migrations_ran(
-                sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message)
-            );
-            return array(
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'script'             => __("Error loading data migration scripts", "event_espresso"),
-                'message'            => $message,
-            );
-        }
-        // ok so we definitely have a data migration script
-        try {
-            // how big of a bite do we want to take? Allow users to easily override via their wp-config
-            if (absint($step_size) < 1) {
-                $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
-                    ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size;
-            }
-            // do what we came to do!
-            $currently_executing_script->migration_step($step_size);
-            // can we wrap it up and verify default data?
-            $init_dbs = false;
-            switch ($currently_executing_script->get_status()) {
-                case EE_Data_Migration_Manager::status_continue:
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_continue,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    );
-                    break;
-                case EE_Data_Migration_Manager::status_completed:
-                    // ok so THAT script has completed
-                    $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_completed,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => sprintf(
-                            __("%s Completed", 'event_espresso'),
-                            $currently_executing_script->pretty_name()
-                        ),
-                    );
-                    // check if there are any more after this one.
-                    $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
-                        // we should be good to allow them to exit maintenance mode now
-                        EE_Maintenance_Mode::instance()->set_maintenance_level(
-                            intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
-                        );
-                        // huh, no more scripts to run... apparently we're done!
-                        // but dont forget to make sure initial data is there
-                        $init_dbs = true;
-                        $response_array['status'] = self::status_no_more_migration_scripts;
-                    }
-                    break;
-                default:
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => $currently_executing_script->get_status(),
-                        'message'            => sprintf(
-                            __("Minor errors occurred during %s: %s", "event_espresso"),
-                            $currently_executing_script->pretty_name(),
-                            implode(", ", $currently_executing_script->get_errors())
-                        ),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    );
-                    break;
-            }
-        } catch (Exception $e) {
-            // ok so some exception was thrown which killed the data migration script
-            // double-check we have a real script
-            if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
-                $script_name = $currently_executing_script->pretty_name();
-                $currently_executing_script->set_broken();
-                $currently_executing_script->add_error($e->getMessage());
-            } else {
-                $script_name = __("Error getting Migration Script", "event_espresso");
-            }
-            $response_array = array(
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'message'            => sprintf(
-                    __("A fatal error occurred during the migration: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => $script_name,
-            );
-        }
-        $successful_save = $this->_save_migrations_ran();
-        if ($successful_save !== true) {
-            // ok so the current wp option didn't save. that's tricky, because we'd like to update it
-            // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
-            // however, if we throw an exception, and return that, then the next request
-            // won't have as much info in it, and it may be able to save
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
-                        "event_espresso"
-                    ),
-                    $successful_save
-                )
-            );
-        }
-        // if we're all done, initialize EE plugins' default data etc.
-        if ($init_dbs) {
-            $this->initialize_db_for_enqueued_ee_plugins();
-        }
-        return $response_array;
-    }
-
-
-    /**
-     * Echo out JSON response to migration script AJAX requests. Takes precautions
-     * to buffer output so that we don't throw junk into our json.
-     *
-     * @return array with keys:
-     * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
-     * it's NOT the count of hwo many remain)
-     * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
-     * records_migrated/records_to_migrate)
-     * 'status'=>a string, one of EE_Data_migration_Manager::status_*
-     * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
-     * errors, notifications, and successes
-     * 'script'=>a pretty name of the script currently running
-     */
-    public function response_to_migration_ajax_request()
-    {
-        ob_start();
-        try {
-            $response = $this->migration_step();
-        } catch (Exception $e) {
-            $response = array(
-                'records_to_migrate' => 0,
-                'records_migrated'   => 0,
-                'status'             => EE_Data_Migration_Manager::status_fatal_error,
-                'message'            => sprintf(
-                    __("Unknown fatal error occurred: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => 'Unknown',
-            );
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
-        }
-        $warnings_etc = @ob_get_contents();
-        ob_end_clean();
-        $response['message'] .= $warnings_etc;
-        return $response;
-    }
-
-    /**
-     * Updates the wordpress option that keeps track of which which EE version the database
-     * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return void
-     */
-    public function update_current_database_state_to($slug_and_version = null)
-    {
-        if (! $slug_and_version) {
-            // no version was provided, assume it should be at the current code version
-            $slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
-        }
-        $current_database_state = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
-        update_option(self::current_database_state, $current_database_state);
-    }
-
-    /**
-     * Determines if the database is currently at a state matching what's indicated in $slug and $version.
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return boolean
-     */
-    public function database_needs_updating_to($slug_and_version)
-    {
-
-        $slug = $slug_and_version['slug'];
-        $version = $slug_and_version['version'];
-        $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
-            return true;
-        } else {
-            // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
-            $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
-            $needs_updating = false;
-            foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
-                    $needs_updating = true;
-                    break;
-                }
-            }
-            return $needs_updating;
-        }
-    }
-
-
-    /**
-     * Gets all the data migration scripts available in the core folder and folders
-     * in addons. Has the side effect of adding them for autoloading
-     *
-     * @return array keys are expected classnames, values are their filepaths
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_all_data_migration_scripts_available()
-    {
-        if (! $this->_data_migration_class_to_filepath_map) {
-            $this->_data_migration_class_to_filepath_map = array();
-            foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
-                // strip any placeholders added to classname to make it a unique array key
-                $eeAddonClass = trim($eeAddonClass, '*');
-                $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
-                    ? $eeAddonClass
-                    : '';
-                $folder_path = EEH_File::end_with_directory_separator($folder_path);
-                $files = glob($folder_path . '*.dms.php');
-                if (empty($files)) {
-                    continue;
-                }
-                foreach ($files as $file) {
-                    $pos_of_last_slash = strrpos($file, '/');
-                    $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
-                    $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass);
-                    $slug = $migrates_to['slug'];
-                    // check that the slug as contained in the DMS is associated with
-                    // the slug of an addon or core
-                    if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
-                        EE_Error::doing_it_wrong(
-                            __FUNCTION__,
-                            sprintf(
-                                esc_html__(
-                                    'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
-                                    'event_espresso'
-                                ),
-                                $classname,
-                                $slug,
-                                implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
-                            ),
-                            '4.3.0.alpha.019'
-                        );
-                    }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
-                }
-            }
-            EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
-        }
-        return $this->_data_migration_class_to_filepath_map;
-    }
-
-
-    /**
-     * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
-     * from each addon, and check if they need updating,
-     *
-     * @return boolean
-     */
-    public function addons_need_updating()
-    {
-        return false;
-    }
-
-    /**
-     * Adds this error string to the data_migrations_ran array, but we dont necessarily know
-     * where to put it, so we just throw it in there... better than nothing...
-     *
-     * @param string $error_message
-     * @throws EE_Error
-     */
-    public function add_error_to_migrations_ran($error_message)
-    {
-        // get last-ran migration script
-        global $wpdb;
-        $last_migration_script_option = $wpdb->get_row(
-            "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
-            ARRAY_A
-        );
-
-        $last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
-            ? maybe_unserialize($last_migration_script_option['option_value']) : null;
-        // now, tread lightly because we're here because a FATAL non-catchable error
-        // was thrown last time when we were trying to run a data migration script
-        // so the fatal error could have happened while getting the migration script
-        // or doing running it...
-        $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $last_migration_script_option['option_name']
-        ) : null;
-
-        // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet
-        // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done)
-        if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) {
-            // ok then just add this error to its list of errors
-            $last_ran_migration_script_properties['_errors'][] = $error_message;
-            $last_ran_migration_script_properties['_status'] = self::status_fatal_error;
-        } else {
-            // so we don't even know which script was last running
-            // use the data migration error stub, which is designed specifically for this type of thing
-            $general_migration_error = new EE_DMS_Unknown_1_0_0();
-            $general_migration_error->add_error($error_message);
-            $general_migration_error->set_broken();
-            $last_ran_migration_script_properties = $general_migration_error->properties_as_array();
-            $versions_migrated_to = 'Unknown.1.0.0';
-            // now just to make sure appears as last (in case the were previously a fatal error like this)
-            // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
-        }
-        update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
-            $last_ran_migration_script_properties
-        );
-    }
-
-    /**
-     * saves what data migrations have ran to the database
-     *
-     * @return mixed TRUE if successfully saved migrations ran, string if an error occurred
-     */
-    protected function _save_migrations_ran()
-    {
-        if ($this->_data_migrations_ran == null) {
-            $this->get_data_migrations_ran();
-        }
-        // now, we don't want to save actual classes to the DB because that's messy
-        $successful_updates = true;
-        foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
-            foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
-                $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
-                $old_option_value = get_option($option_name);
-                if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
-                    $script_array_for_saving = $array_or_migration_obj->properties_as_array();
-                    if ($old_option_value != $script_array_for_saving) {
-                        $successful_updates = update_option($option_name, $script_array_for_saving);
-                    }
-                } else {// we don't know what this array-thing is. So just save it as-is
-                    if ($old_option_value != $array_or_migration_obj) {
-                        $successful_updates = update_option($option_name, $array_or_migration_obj);
-                    }
-                }
-                if (! $successful_updates) {
-                    global $wpdb;
-                    return $wpdb->last_error;
-                }
-            }
-        }
-        return true;
-        // $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
-        // if ($updated !== true) {
-        //     global $wpdb;
-        //     return $wpdb->last_error;
-        // } else {
-        //     return true;
-        // }
-        // wp_mail(
-        //     "michael@eventespresso.com",
-        //     time() . " price debug info",
-        //     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
-        //         serialize($array_of_migrations)
-        //     )
-        // );
-    }
-
-    /**
-     * Takes an array of data migration script properties and re-creates the class from
-     * them. The argument $properties_array is assumed to have been made by
-     * EE_Data_Migration_Script_Base::properties_as_array()
-     *
-     * @param array $properties_array
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    public function _instantiate_script_from_properties_array($properties_array)
-    {
-        if (! isset($properties_array['class'])) {
-            throw new EE_Error(
-                sprintf(
-                    __("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
-                    implode(",", $properties_array)
-                )
-            );
-        }
-        $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
-            throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
-        }
-        $class = new $class_name;
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
-                    $class_name,
-                    get_class($class)
-                )
-            );
-        }
-        $class->instantiate_from_array_of_properties($properties_array);
-        return $class;
-    }
-
-    /**
-     * Gets the classname for the most up-to-date DMS (ie, the one that will finally
-     * leave the DB in a state usable by the current plugin code).
-     *
-     * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
-     * @return string
-     */
-    public function get_most_up_to_date_dms($plugin_slug = 'Core')
-    {
-        $class_to_filepath_map = $this->get_all_data_migration_scripts_available();
-        $most_up_to_date_dms_classname = null;
-        foreach ($class_to_filepath_map as $classname => $filepath) {
-            if ($most_up_to_date_dms_classname === null) {
-                $migrates_to = $this->script_migrates_to_version($classname);
-                $this_plugin_slug = $migrates_to['slug'];
-                if ($this_plugin_slug == $plugin_slug) {
-                    // if it's for core, it wins
-                    $most_up_to_date_dms_classname = $classname;
-                }
-                // if it wasn't for core, we must keep searching for one that is!
-                continue;
-            } else {
-                $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname);
-                $contender_migrates_to = $this->script_migrates_to_version($classname);
-                if ($contender_migrates_to['slug'] == $plugin_slug
-                    && version_compare(
-                        $champion_migrates_to['version'],
-                        $contender_migrates_to['version'],
-                        '<'
-                    )) {
-                    // so the contenders version is higher and its for Core
-                    $most_up_to_date_dms_classname = $classname;
-                }
-            }
-        }
-        return $most_up_to_date_dms_classname;
-    }
-
-    /**
-     * Gets the migration script specified but ONLY if it has already ran.
-     *
-     * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code:
-     * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
-     * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
-     * other addon) DMS has ran, in case the current DMS depends on it.
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return EE_Data_Migration_Script_Base
-     */
-    public function get_migration_ran($version, $plugin_slug = 'Core')
-    {
-        $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Resets the borked data migration scripts so they're no longer borked
-     * so we can again attempt to migrate
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function reattempt()
-    {
-        // find if the last-ran script was borked
-        // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
-        // add an 'error' saying that we attempted to reset
-        // does it have a stage that was borked too? if so make it no longer borked
-        // add an 'error' saying we attempted to reset
-        $last_ran_script = $this->get_last_ran_script();
-        if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
-            // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
-            $last_ran_script->set_completed();
-        } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
-            $last_ran_script->reattempt();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
-                        'event_espresso'
-                    ),
-                    print_r($last_ran_script, true)
-                )
-            );
-        }
-        return $this->_save_migrations_ran();
-    }
-
-    /**
-     * Gets whether or not this particular migration has run or not
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return boolean
-     */
-    public function migration_has_ran($version, $plugin_slug = 'Core')
-    {
-        return $this->get_migration_ran($version, $plugin_slug) !== null;
-    }
-
-    /**
-     * Enqueues this ee plugin to have its data initialized
-     *
-     * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
-     */
-    public function enqueue_db_initialization_for($plugin_slug)
-    {
-        $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
-            $queue[] = $plugin_slug;
-        }
-        update_option(self::db_init_queue_option_name, $queue);
-    }
-
-    /**
-     * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
-     * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
-     * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
-     */
-    public function initialize_db_for_enqueued_ee_plugins()
-    {
-        $queue = $this->get_db_initialization_queue();
-        foreach ($queue as $plugin_slug) {
-            $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
-                // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
-                $verify_db = false;
-            } else {
-                $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
-                $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
-            }
-            if ($plugin_slug == 'Core') {
-                EE_System::instance()->initialize_db_if_no_migrations_required(
-                    false,
-                    $verify_db
-                );
-            } else {
-                // just loop through the addons to make sure their database is setup
-                foreach (EE_Registry::instance()->addons as $addon) {
-                    if ($addon->name() == $plugin_slug) {
-                        $addon->initialize_db_if_no_migrations_required($verify_db);
-                        break;
-                    }
-                }
-            }
-        }
-        // because we just initialized the DBs for the enqueued ee plugins
-        // we don't need to keep remembering which ones needed to be initialized
-        delete_option(self::db_init_queue_option_name);
-    }
-
-    /**
-     * Gets a numerically-indexed array of plugin slugs that need to have their databases
-     * (re-)initialized after migrations are complete. ie, each element should be either
-     * 'Core', or the return value of EE_Addon::name() for an addon
-     *
-     * @return array
-     */
-    public function get_db_initialization_queue()
-    {
-        return get_option(self::db_init_queue_option_name, array());
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table manager, or throws an exception
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	// protected $EE;
+	/**
+	 * name of the wordpress option which stores an array of data about
+	 */
+	const data_migrations_option_name = 'ee_data_migration';
+
+
+	const data_migration_script_option_prefix = 'ee_data_migration_script_';
+
+	const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
+
+	/**
+	 * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0,
+	 * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
+	 */
+	const current_database_state = 'ee_data_migration_current_db_state';
+
+	/**
+	 * Special status string returned when we're positive there are no more data migration
+	 * scripts that can be run.
+	 */
+	const status_no_more_migration_scripts = 'no_more_migration_scripts';
+	/**
+	 * string indicating the migration should continue
+	 */
+	const status_continue = 'status_continue';
+	/**
+	 * string indicating the migration has completed and should be ended
+	 */
+	const status_completed = 'status_completed';
+	/**
+	 * string indicating a fatal error occurred and the data migration should be completely aborted
+	 */
+	const status_fatal_error = 'status_fatal_error';
+
+	/**
+	 * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
+	 * during migration)
+	 */
+	const step_size = 50;
+
+	/**
+	 * option name that stores the queue of ee plugins needing to have
+	 * their data initialized (or re-initialized) once we are done migrations
+	 */
+	const db_init_queue_option_name = 'ee_db_init_queue';
+	/**
+	 * Array of information concerning data migrations that have ran in the history
+	 * of this EE installation. Keys should be the name of the version the script upgraded to
+	 *
+	 * @var EE_Data_Migration_Script_Base[]
+	 */
+	private $_data_migrations_ran = null;
+	/**
+	 * The last ran script. It's nice to store this somewhere accessible, as its easiest
+	 * to know which was the last run by which is the newest wp option; but in most of the code
+	 * we just use the local $_data_migration_ran array, which organized the scripts differently
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_script = null;
+
+	/**
+	 * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_incomplete_script = null;
+	/**
+	 * array where keys are classnames, and values are filepaths of all the known migration scripts
+	 *
+	 * @var array
+	 */
+	private $_data_migration_class_to_filepath_map;
+
+	/**
+	 * the following 4 properties are fully set on construction.
+	 * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
+	 * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
+	 * data migration script
+	 *
+	 * @var array
+	 */
+	public $stati_that_indicate_to_continue_migrations = array();
+
+	public $stati_that_indicate_to_stop_migrations = array();
+
+	public $stati_that_indicate_to_continue_single_migration_script = array();
+
+	public $stati_that_indicate_to_stop_single_migration_script = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+	/**
+	 * @var array $script_migration_versions
+	 */
+	protected $script_migration_versions;
+
+	/**
+	 * @var EE_Data_Migration_Manager $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Data_Migration_Manager instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
+	 * all new usages of the singleton should be made with Classname::instance()) and returns it
+	 *
+	 * @return EE_Data_Migration_Manager
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * constructor
+	 */
+	private function __construct()
+	{
+		$this->stati_that_indicate_to_continue_migrations = array(
+			self::status_continue,
+			self::status_completed,
+		);
+		$this->stati_that_indicate_to_stop_migrations = array(
+			self::status_fatal_error,
+			self::status_no_more_migration_scripts,
+		);
+		$this->stati_that_indicate_to_continue_single_migration_script = array(
+			self::status_continue,
+		);
+		$this->stati_that_indicate_to_stop_single_migration_script = array(
+			self::status_completed,
+			self::status_fatal_error
+			// note: status_no_more_migration_scripts doesn't apply
+		);
+		// make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
+		// to be defined, because right now it doesn't get autoloaded on its own
+		EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true);
+		EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true);
+		$this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+	}
+
+
+	/**
+	 * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
+	 * the option names are like, but generally they're like
+	 * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
+	 * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
+	 * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg
+	 * EE_DMS_Core_4_1_0.dms.php)
+	 *
+	 * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
+	 * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of
+	 *               that plugin (eg '4.1.0')
+	 */
+	private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
+	{
+		$plugin_slug_and_version_string = str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$option_name
+		);
+		// check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
+		$parts = explode(".", $plugin_slug_and_version_string);
+
+		if (count($parts) == 4) {
+			// it's 4.2-style.eg Core.4.1.0
+			$plugin_slug = $parts[0];// eg Core
+			$version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+		} else {
+			// it's 4.1-style: eg 4.1.0
+			$plugin_slug = 'Core';
+			$version_string = $plugin_slug_and_version_string;// eg 4.1.0
+		}
+		return array($plugin_slug, $version_string);
+	}
+
+	/**
+	 * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not
+	 * for a known DMS class.
+	 *
+	 * @param string $dms_option_name
+	 * @param string $dms_option_value (serialized)
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
+	{
+		$data_migration_data = maybe_unserialize($dms_option_value);
+		if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
+			$class = LoaderFactory::getLoader()->getShared($data_migration_data['class']);
+			if ($class instanceof EE_Data_Migration_Script_Base) {
+				$class->instantiate_from_array_of_properties($data_migration_data);
+				return $class;
+			} else {
+				// huh, so its an object but not a data migration script?? that shouldn't happen
+				// just leave it as an array (which will probably just get ignored)
+				throw new EE_Error(
+					sprintf(
+						__(
+							"Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
+							'event_espresso'
+						),
+						$data_migration_data['class']
+					)
+				);
+			}
+		} else {
+			// so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
+			throw new EE_Error(
+				sprintf(__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name)
+			);
+		}
+	}
+
+	/**
+	 * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last
+	 * ran, and which was the last ran which hasn't finished yet
+	 *
+	 * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy
+	 *               arrays in there - which should probably be ignored)
+	 */
+	public function get_data_migrations_ran()
+	{
+		if (! $this->_data_migrations_ran) {
+			// setup autoloaders for each of the scripts in there
+			$this->get_all_data_migration_scripts_available();
+			$data_migrations_options = $this->get_all_migration_script_options(
+			);// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+
+			$data_migrations_ran = array();
+			// convert into data migration script classes where possible
+			foreach ($data_migrations_options as $data_migration_option) {
+				list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
+					$data_migration_option['option_name']
+				);
+
+				try {
+					$class = $this->_get_dms_class_from_wp_option(
+						$data_migration_option['option_name'],
+						$data_migration_option['option_value']
+					);
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+					// ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
+					$this->_last_ran_script = $class;
+					if (! $class->is_completed()) {
+						// sometimes we also like to know which was the last incomplete script (or if there are any at all)
+						$this->_last_ran_incomplete_script = $class;
+					}
+				} catch (EE_Error $e) {
+					// ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+						$data_migration_option['option_value']
+					);
+				}
+			}
+			// so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
+			$this->_data_migrations_ran = $data_migrations_ran;
+			if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+				$this->_data_migrations_ran = array();
+			}
+		}
+		return $this->_data_migrations_ran;
+	}
+
+
+	/**
+	 *
+	 * @param string $script_name eg 'DMS_Core_4_1_0'
+	 * @param string $old_table   eg 'wp_events_detail'
+	 * @param string $old_pk      eg 'wp_esp_posts'
+	 * @param        $new_table
+	 * @return mixed string or int
+	 */
+	public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
+	{
+		$script = EE_Registry::instance()->load_dms($script_name);
+		$mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
+		return $mapping;
+	}
+
+	/**
+	 * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
+	 * the last option returned in this array is the most-recently ran DMS option
+	 *
+	 * @return array
+	 */
+	public function get_all_migration_script_options()
+	{
+		global $wpdb;
+		return $wpdb->get_results(
+			"SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
+			ARRAY_A
+		);
+	}
+
+	/**
+	 * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
+	 *
+	 * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
+	 *               slashes at the end of the folder name.
+	 */
+	public function get_data_migration_script_folders()
+	{
+		return apply_filters(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			array('Core' => EE_CORE . 'data_migration_scripts')
+		);
+	}
+
+	/**
+	 * Gets the version the migration script upgrades to
+	 *
+	 * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
+	 * @return array {
+	 * @type string  $slug                  like 'Core','Calendar',etc
+	 * @type string  $version               like 4.3.0
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
+	{
+		if (isset($this->script_migration_versions[ $migration_script_name ])) {
+			return $this->script_migration_versions[ $migration_script_name ];
+		}
+		$dms_info = $this->parse_dms_classname($migration_script_name);
+		$this->script_migration_versions[ $migration_script_name ] = array(
+			'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
+			'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
+		);
+		return $this->script_migration_versions[ $migration_script_name ];
+	}
+
+	/**
+	 * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
+	 *
+	 * @param string $classname
+	 * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints)
+	 * @throws EE_Error
+	 */
+	public function parse_dms_classname($classname)
+	{
+		$matches = array();
+		preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
+		if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		return array(
+			'slug'          => $matches[1],
+			'major_version' => intval($matches[2]),
+			'minor_version' => intval($matches[3]),
+			'micro_version' => intval($matches[4]),
+		);
+	}
+
+	/**
+	 * Ensures that the option indicating the current DB version is set. This should only be
+	 * a concern when activating EE for the first time, THEORETICALLY.
+	 * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
+	 * to 4.1.x.
+	 *
+	 * @return string of current db state
+	 */
+	public function ensure_current_database_state_is_set()
+	{
+		$espresso_db_core_updates = get_option('espresso_db_update', array());
+		$db_state = get_option(EE_Data_Migration_Manager::current_database_state);
+		if (! $db_state) {
+			// mark the DB as being in the state as the last version in there.
+			// this is done to trigger maintenance mode and do data migration scripts
+			// if the admin installed this version of EE over 3.1.x or 4.0.x
+			// otherwise, the normal maintenance mode code is fine
+			$previous_versions_installed = array_keys($espresso_db_core_updates);
+			$previous_version_installed = end($previous_versions_installed);
+			if (version_compare('4.1.0', $previous_version_installed)) {
+				// last installed version was less than 4.1
+				// so we want the data migrations to happen. SO, we're going to say the DB is at that state
+				$db_state = array('Core' => $previous_version_installed);
+			} else {
+				$db_state = array('Core' => EVENT_ESPRESSO_VERSION);
+			}
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		// in 4.1, $db_state would have only been a simple string like '4.1.0',
+		// but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
+		// db, and possibly other keys for other addons like 'Calendar','Permissions',etc
+		if (! is_array($db_state)) {
+			$db_state = array('Core' => $db_state);
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		return $db_state;
+	}
+
+	/**
+	 * Checks if there are any data migration scripts that ought to be run. If found,
+	 * returns the instantiated classes. If none are found (ie, they've all already been run
+	 * or they don't apply), returns an empty array
+	 *
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function check_for_applicable_data_migration_scripts()
+	{
+		// get the option describing what options have already run
+		$scripts_ran = $this->get_data_migrations_ran();
+		// $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
+		$script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
+
+
+		$current_database_state = $this->ensure_current_database_state_is_set();
+		// determine which have already been run
+		$script_classes_that_should_run_per_iteration = array();
+		$iteration = 0;
+		$next_database_state_to_consider = $current_database_state;
+		$theoretical_database_state = null;
+		do {
+			// the next state after the currently-considered one will start off looking the same as the current, but we may make additions...
+			$theoretical_database_state = $next_database_state_to_consider;
+			// the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?)
+			foreach ($script_class_and_filepaths_available as $classname => $filepath) {
+				$migrates_to_version = $this->script_migrates_to_version($classname);
+				$script_converts_plugin_slug = $migrates_to_version['slug'];
+				$script_converts_to_version = $migrates_to_version['version'];
+				// check if this version script is DONE or not; or if it's never been ran
+				if (! $scripts_ran ||
+					! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
+					! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
+					// we haven't ran this conversion script before
+					// now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
+					$script = LoaderFactory::getLoader()->load($classname);
+					/* @var $script EE_Data_Migration_Script_Base */
+					$can_migrate = $script->can_migrate_from_version($theoretical_database_state);
+					if ($can_migrate) {
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version = $script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					}
+				} elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
+					// this script has been ran, or at least started
+					$script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+					if ($script->get_status() != self::status_completed) {
+						// this script is already underway... keep going with it
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version = $script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					} else {
+						// it must have a status that indicates it has finished, so we don't want to try and run it again
+					}
+				} else {
+					// it exists but it's not  a proper data migration script
+					// maybe the script got renamed? or was simply removed from EE?
+					// either way, its certainly not runnable!
+				}
+			}
+			$iteration++;
+		} while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
+		// ok we have all the scripts that should run, now let's make them into flat array
+		$scripts_that_should_run = array();
+		foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
+			ksort($scripts_at_priority);
+			foreach ($scripts_at_priority as $scripts) {
+				foreach ($scripts as $script) {
+					$scripts_that_should_run[ get_class($script) ] = $script;
+				}
+			}
+		}
+
+		do_action(
+			'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
+			$scripts_that_should_run
+		);
+		return $scripts_that_should_run;
+	}
+
+
+	/**
+	 * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE
+	 * it will return the last ran script even if its complete.
+	 * This means: if you want to find the currently-executing script, leave it as FALSE.
+	 * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
+	 *
+	 * @param bool $include_completed_scripts
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	public function get_last_ran_script($include_completed_scripts = false)
+	{
+		// make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
+		if (! $this->_data_migrations_ran) {
+			$this->get_data_migrations_ran();
+		}
+		if ($include_completed_scripts) {
+			return $this->_last_ran_script;
+		} else {
+			return $this->_last_ran_incomplete_script;
+		}
+	}
+
+
+	/**
+	 * Runs the data migration scripts (well, each request to this method calls one of the
+	 * data migration scripts' migration_step() functions).
+	 *
+	 * @param int   $step_size
+	 * @throws EE_Error
+	 * @return array {
+	 *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
+	 *                                  //and the second item is a string describing what was done
+	 * @type int    $records_to_migrate from the current migration script
+	 * @type int    $records_migrated
+	 * @type string $status             one of EE_Data_Migration_Manager::status_*
+	 * @type string $script             verbose name of the current DMS
+	 * @type string $message            string describing what was done during this step
+	 *                                  }
+	 */
+	public function migration_step($step_size = 0)
+	{
+
+		// bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
+		if (class_exists('EE_CPT_Strategy')) {
+			remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5);
+		}
+
+		try {
+			$currently_executing_script = $this->get_last_ran_script();
+			if (! $currently_executing_script) {
+				// Find the next script that needs to execute
+				$scripts = $this->check_for_applicable_data_migration_scripts();
+				if (! $scripts) {
+					// huh, no more scripts to run... apparently we're done!
+					// but dont forget to make sure initial data is there
+					// we should be good to allow them to exit maintenance mode now
+					EE_Maintenance_Mode::instance()->set_maintenance_level(
+						intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
+					);
+					// saving migrations ran should actually be unnecessary, but leaving in place just in case
+					// remember this migration was finished (even if we timeout initing db for core and plugins)
+					$this->_save_migrations_ran();
+					// make sure DB was updated AFTER we've recorded the migration was done
+					$this->initialize_db_for_enqueued_ee_plugins();
+					return array(
+						'records_to_migrate' => 1,
+						'records_migrated'   => 1,
+						'status'             => self::status_no_more_migration_scripts,
+						'script'             => __("Data Migration Completed Successfully", "event_espresso"),
+						'message'            => __("All done!", "event_espresso"),
+					);
+				}
+				$currently_executing_script = array_shift($scripts);
+				// and add to the array/wp option showing the scripts ran
+
+				$migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
+				$plugin_slug = $migrates_to['slug'];
+				$version = $migrates_to['version'];
+				$this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+			}
+			$current_script_name = get_class($currently_executing_script);
+		} catch (Exception $e) {
+			// an exception occurred while trying to get migration scripts
+
+			$message = sprintf(
+				__("Error Message: %sStack Trace:%s", "event_espresso"),
+				$e->getMessage() . '<br>',
+				$e->getTraceAsString()
+			);
+			// record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
+			// but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
+			$this->add_error_to_migrations_ran(
+				sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message)
+			);
+			return array(
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'script'             => __("Error loading data migration scripts", "event_espresso"),
+				'message'            => $message,
+			);
+		}
+		// ok so we definitely have a data migration script
+		try {
+			// how big of a bite do we want to take? Allow users to easily override via their wp-config
+			if (absint($step_size) < 1) {
+				$step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
+					? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size;
+			}
+			// do what we came to do!
+			$currently_executing_script->migration_step($step_size);
+			// can we wrap it up and verify default data?
+			$init_dbs = false;
+			switch ($currently_executing_script->get_status()) {
+				case EE_Data_Migration_Manager::status_continue:
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_continue,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => $currently_executing_script->pretty_name(),
+					);
+					break;
+				case EE_Data_Migration_Manager::status_completed:
+					// ok so THAT script has completed
+					$this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_completed,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => sprintf(
+							__("%s Completed", 'event_espresso'),
+							$currently_executing_script->pretty_name()
+						),
+					);
+					// check if there are any more after this one.
+					$scripts_remaining = $this->check_for_applicable_data_migration_scripts();
+					if (! $scripts_remaining) {
+						// we should be good to allow them to exit maintenance mode now
+						EE_Maintenance_Mode::instance()->set_maintenance_level(
+							intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
+						);
+						// huh, no more scripts to run... apparently we're done!
+						// but dont forget to make sure initial data is there
+						$init_dbs = true;
+						$response_array['status'] = self::status_no_more_migration_scripts;
+					}
+					break;
+				default:
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => $currently_executing_script->get_status(),
+						'message'            => sprintf(
+							__("Minor errors occurred during %s: %s", "event_espresso"),
+							$currently_executing_script->pretty_name(),
+							implode(", ", $currently_executing_script->get_errors())
+						),
+						'script'             => $currently_executing_script->pretty_name(),
+					);
+					break;
+			}
+		} catch (Exception $e) {
+			// ok so some exception was thrown which killed the data migration script
+			// double-check we have a real script
+			if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
+				$script_name = $currently_executing_script->pretty_name();
+				$currently_executing_script->set_broken();
+				$currently_executing_script->add_error($e->getMessage());
+			} else {
+				$script_name = __("Error getting Migration Script", "event_espresso");
+			}
+			$response_array = array(
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'message'            => sprintf(
+					__("A fatal error occurred during the migration: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => $script_name,
+			);
+		}
+		$successful_save = $this->_save_migrations_ran();
+		if ($successful_save !== true) {
+			// ok so the current wp option didn't save. that's tricky, because we'd like to update it
+			// and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
+			// however, if we throw an exception, and return that, then the next request
+			// won't have as much info in it, and it may be able to save
+			throw new EE_Error(
+				sprintf(
+					__(
+						"The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
+						"event_espresso"
+					),
+					$successful_save
+				)
+			);
+		}
+		// if we're all done, initialize EE plugins' default data etc.
+		if ($init_dbs) {
+			$this->initialize_db_for_enqueued_ee_plugins();
+		}
+		return $response_array;
+	}
+
+
+	/**
+	 * Echo out JSON response to migration script AJAX requests. Takes precautions
+	 * to buffer output so that we don't throw junk into our json.
+	 *
+	 * @return array with keys:
+	 * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
+	 * it's NOT the count of hwo many remain)
+	 * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
+	 * records_migrated/records_to_migrate)
+	 * 'status'=>a string, one of EE_Data_migration_Manager::status_*
+	 * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
+	 * errors, notifications, and successes
+	 * 'script'=>a pretty name of the script currently running
+	 */
+	public function response_to_migration_ajax_request()
+	{
+		ob_start();
+		try {
+			$response = $this->migration_step();
+		} catch (Exception $e) {
+			$response = array(
+				'records_to_migrate' => 0,
+				'records_migrated'   => 0,
+				'status'             => EE_Data_Migration_Manager::status_fatal_error,
+				'message'            => sprintf(
+					__("Unknown fatal error occurred: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => 'Unknown',
+			);
+			$this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+		}
+		$warnings_etc = @ob_get_contents();
+		ob_end_clean();
+		$response['message'] .= $warnings_etc;
+		return $response;
+	}
+
+	/**
+	 * Updates the wordpress option that keeps track of which which EE version the database
+	 * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return void
+	 */
+	public function update_current_database_state_to($slug_and_version = null)
+	{
+		if (! $slug_and_version) {
+			// no version was provided, assume it should be at the current code version
+			$slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
+		}
+		$current_database_state = get_option(self::current_database_state);
+		$current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+		update_option(self::current_database_state, $current_database_state);
+	}
+
+	/**
+	 * Determines if the database is currently at a state matching what's indicated in $slug and $version.
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return boolean
+	 */
+	public function database_needs_updating_to($slug_and_version)
+	{
+
+		$slug = $slug_and_version['slug'];
+		$version = $slug_and_version['version'];
+		$current_database_state = get_option(self::current_database_state);
+		if (! isset($current_database_state[ $slug ])) {
+			return true;
+		} else {
+			// just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
+			$version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+			$version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
+			$needs_updating = false;
+			foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
+				if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+					$needs_updating = true;
+					break;
+				}
+			}
+			return $needs_updating;
+		}
+	}
+
+
+	/**
+	 * Gets all the data migration scripts available in the core folder and folders
+	 * in addons. Has the side effect of adding them for autoloading
+	 *
+	 * @return array keys are expected classnames, values are their filepaths
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_all_data_migration_scripts_available()
+	{
+		if (! $this->_data_migration_class_to_filepath_map) {
+			$this->_data_migration_class_to_filepath_map = array();
+			foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
+				// strip any placeholders added to classname to make it a unique array key
+				$eeAddonClass = trim($eeAddonClass, '*');
+				$eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
+					? $eeAddonClass
+					: '';
+				$folder_path = EEH_File::end_with_directory_separator($folder_path);
+				$files = glob($folder_path . '*.dms.php');
+				if (empty($files)) {
+					continue;
+				}
+				foreach ($files as $file) {
+					$pos_of_last_slash = strrpos($file, '/');
+					$classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
+					$migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass);
+					$slug = $migrates_to['slug'];
+					// check that the slug as contained in the DMS is associated with
+					// the slug of an addon or core
+					if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
+						EE_Error::doing_it_wrong(
+							__FUNCTION__,
+							sprintf(
+								esc_html__(
+									'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
+									'event_espresso'
+								),
+								$classname,
+								$slug,
+								implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
+							),
+							'4.3.0.alpha.019'
+						);
+					}
+					$this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+				}
+			}
+			EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
+		}
+		return $this->_data_migration_class_to_filepath_map;
+	}
+
+
+	/**
+	 * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
+	 * from each addon, and check if they need updating,
+	 *
+	 * @return boolean
+	 */
+	public function addons_need_updating()
+	{
+		return false;
+	}
+
+	/**
+	 * Adds this error string to the data_migrations_ran array, but we dont necessarily know
+	 * where to put it, so we just throw it in there... better than nothing...
+	 *
+	 * @param string $error_message
+	 * @throws EE_Error
+	 */
+	public function add_error_to_migrations_ran($error_message)
+	{
+		// get last-ran migration script
+		global $wpdb;
+		$last_migration_script_option = $wpdb->get_row(
+			"SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
+			ARRAY_A
+		);
+
+		$last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
+			? maybe_unserialize($last_migration_script_option['option_value']) : null;
+		// now, tread lightly because we're here because a FATAL non-catchable error
+		// was thrown last time when we were trying to run a data migration script
+		// so the fatal error could have happened while getting the migration script
+		// or doing running it...
+		$versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$last_migration_script_option['option_name']
+		) : null;
+
+		// check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet
+		// because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done)
+		if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) {
+			// ok then just add this error to its list of errors
+			$last_ran_migration_script_properties['_errors'][] = $error_message;
+			$last_ran_migration_script_properties['_status'] = self::status_fatal_error;
+		} else {
+			// so we don't even know which script was last running
+			// use the data migration error stub, which is designed specifically for this type of thing
+			$general_migration_error = new EE_DMS_Unknown_1_0_0();
+			$general_migration_error->add_error($error_message);
+			$general_migration_error->set_broken();
+			$last_ran_migration_script_properties = $general_migration_error->properties_as_array();
+			$versions_migrated_to = 'Unknown.1.0.0';
+			// now just to make sure appears as last (in case the were previously a fatal error like this)
+			// delete the old one
+			delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+		}
+		update_option(
+			self::data_migration_script_option_prefix . $versions_migrated_to,
+			$last_ran_migration_script_properties
+		);
+	}
+
+	/**
+	 * saves what data migrations have ran to the database
+	 *
+	 * @return mixed TRUE if successfully saved migrations ran, string if an error occurred
+	 */
+	protected function _save_migrations_ran()
+	{
+		if ($this->_data_migrations_ran == null) {
+			$this->get_data_migrations_ran();
+		}
+		// now, we don't want to save actual classes to the DB because that's messy
+		$successful_updates = true;
+		foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
+			foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
+				$plugin_slug_for_use_in_option_name = $plugin_slug . ".";
+				$option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+				$old_option_value = get_option($option_name);
+				if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
+					$script_array_for_saving = $array_or_migration_obj->properties_as_array();
+					if ($old_option_value != $script_array_for_saving) {
+						$successful_updates = update_option($option_name, $script_array_for_saving);
+					}
+				} else {// we don't know what this array-thing is. So just save it as-is
+					if ($old_option_value != $array_or_migration_obj) {
+						$successful_updates = update_option($option_name, $array_or_migration_obj);
+					}
+				}
+				if (! $successful_updates) {
+					global $wpdb;
+					return $wpdb->last_error;
+				}
+			}
+		}
+		return true;
+		// $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
+		// if ($updated !== true) {
+		//     global $wpdb;
+		//     return $wpdb->last_error;
+		// } else {
+		//     return true;
+		// }
+		// wp_mail(
+		//     "michael@eventespresso.com",
+		//     time() . " price debug info",
+		//     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
+		//         serialize($array_of_migrations)
+		//     )
+		// );
+	}
+
+	/**
+	 * Takes an array of data migration script properties and re-creates the class from
+	 * them. The argument $properties_array is assumed to have been made by
+	 * EE_Data_Migration_Script_Base::properties_as_array()
+	 *
+	 * @param array $properties_array
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	public function _instantiate_script_from_properties_array($properties_array)
+	{
+		if (! isset($properties_array['class'])) {
+			throw new EE_Error(
+				sprintf(
+					__("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
+					implode(",", $properties_array)
+				)
+			);
+		}
+		$class_name = $properties_array['class'];
+		if (! class_exists($class_name)) {
+			throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
+		}
+		$class = new $class_name;
+		if (! $class instanceof EE_Data_Migration_Script_Base) {
+			throw new EE_Error(
+				sprintf(
+					__("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
+					$class_name,
+					get_class($class)
+				)
+			);
+		}
+		$class->instantiate_from_array_of_properties($properties_array);
+		return $class;
+	}
+
+	/**
+	 * Gets the classname for the most up-to-date DMS (ie, the one that will finally
+	 * leave the DB in a state usable by the current plugin code).
+	 *
+	 * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
+	 * @return string
+	 */
+	public function get_most_up_to_date_dms($plugin_slug = 'Core')
+	{
+		$class_to_filepath_map = $this->get_all_data_migration_scripts_available();
+		$most_up_to_date_dms_classname = null;
+		foreach ($class_to_filepath_map as $classname => $filepath) {
+			if ($most_up_to_date_dms_classname === null) {
+				$migrates_to = $this->script_migrates_to_version($classname);
+				$this_plugin_slug = $migrates_to['slug'];
+				if ($this_plugin_slug == $plugin_slug) {
+					// if it's for core, it wins
+					$most_up_to_date_dms_classname = $classname;
+				}
+				// if it wasn't for core, we must keep searching for one that is!
+				continue;
+			} else {
+				$champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname);
+				$contender_migrates_to = $this->script_migrates_to_version($classname);
+				if ($contender_migrates_to['slug'] == $plugin_slug
+					&& version_compare(
+						$champion_migrates_to['version'],
+						$contender_migrates_to['version'],
+						'<'
+					)) {
+					// so the contenders version is higher and its for Core
+					$most_up_to_date_dms_classname = $classname;
+				}
+			}
+		}
+		return $most_up_to_date_dms_classname;
+	}
+
+	/**
+	 * Gets the migration script specified but ONLY if it has already ran.
+	 *
+	 * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code:
+	 * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
+	 * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
+	 * other addon) DMS has ran, in case the current DMS depends on it.
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	public function get_migration_ran($version, $plugin_slug = 'Core')
+	{
+		$migrations_ran = $this->get_data_migrations_ran();
+		if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
+			return $migrations_ran[ $plugin_slug ][ $version ];
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Resets the borked data migration scripts so they're no longer borked
+	 * so we can again attempt to migrate
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function reattempt()
+	{
+		// find if the last-ran script was borked
+		// set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
+		// add an 'error' saying that we attempted to reset
+		// does it have a stage that was borked too? if so make it no longer borked
+		// add an 'error' saying we attempted to reset
+		$last_ran_script = $this->get_last_ran_script();
+		if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
+			// if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
+			$last_ran_script->set_completed();
+		} elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
+			$last_ran_script->reattempt();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
+						'event_espresso'
+					),
+					print_r($last_ran_script, true)
+				)
+			);
+		}
+		return $this->_save_migrations_ran();
+	}
+
+	/**
+	 * Gets whether or not this particular migration has run or not
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return boolean
+	 */
+	public function migration_has_ran($version, $plugin_slug = 'Core')
+	{
+		return $this->get_migration_ran($version, $plugin_slug) !== null;
+	}
+
+	/**
+	 * Enqueues this ee plugin to have its data initialized
+	 *
+	 * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
+	 */
+	public function enqueue_db_initialization_for($plugin_slug)
+	{
+		$queue = $this->get_db_initialization_queue();
+		if (! in_array($plugin_slug, $queue)) {
+			$queue[] = $plugin_slug;
+		}
+		update_option(self::db_init_queue_option_name, $queue);
+	}
+
+	/**
+	 * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
+	 * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
+	 * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
+	 */
+	public function initialize_db_for_enqueued_ee_plugins()
+	{
+		$queue = $this->get_db_initialization_queue();
+		foreach ($queue as $plugin_slug) {
+			$most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
+			if (! $most_up_to_date_dms) {
+				// if there is NO DMS for this plugin, obviously there's no schema to verify anyways
+				$verify_db = false;
+			} else {
+				$most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
+				$verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
+			}
+			if ($plugin_slug == 'Core') {
+				EE_System::instance()->initialize_db_if_no_migrations_required(
+					false,
+					$verify_db
+				);
+			} else {
+				// just loop through the addons to make sure their database is setup
+				foreach (EE_Registry::instance()->addons as $addon) {
+					if ($addon->name() == $plugin_slug) {
+						$addon->initialize_db_if_no_migrations_required($verify_db);
+						break;
+					}
+				}
+			}
+		}
+		// because we just initialized the DBs for the enqueued ee plugins
+		// we don't need to keep remembering which ones needed to be initialized
+		delete_option(self::db_init_queue_option_name);
+	}
+
+	/**
+	 * Gets a numerically-indexed array of plugin slugs that need to have their databases
+	 * (re-)initialized after migrations are complete. ie, each element should be either
+	 * 'Core', or the return value of EE_Addon::name() for an addon
+	 *
+	 * @return array
+	 */
+	public function get_db_initialization_queue()
+	{
+		return get_option(self::db_init_queue_option_name, array());
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table manager, or throws an exception
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/EE_Dependency_Map.core.php

Spacing +37 added lines, -37 removed lines

@@ -122,7 +122,7 @@ 
     public static function instance(ClassInterfaceCache $class_cache = null)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map
+        if ( ! self::$_instance instanceof EE_Dependency_Map
             && $class_cache instanceof ClassInterfaceCache
         ) {
             self::$_instance = new EE_Dependency_Map($class_cache);
@@ -203,18 +203,18 @@ 
     ) {
         $class = trim($class, '\\');
         $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
+        if (empty(self::$_instance->_dependency_map[$class])) {
+            self::$_instance->_dependency_map[$class] = array();
         }
         // we need to make sure that any aliases used when registering a dependency
         // get resolved to the correct class name
         foreach ($dependencies as $dependency => $load_source) {
             $alias = self::$_instance->getFqnForAlias($dependency);
             if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+                || ! isset(self::$_instance->_dependency_map[$class][$alias])
             ) {
-                unset($dependencies[ $dependency ]);
-                $dependencies[ $alias ] = $load_source;
+                unset($dependencies[$dependency]);
+                $dependencies[$alias] = $load_source;
                 $registered = true;
             }
         }
@@ -224,13 +224,13 @@ 
         // ie: with A = B + C, entries in B take precedence over duplicate entries in C
         // Union is way faster than array_merge() but should be used with caution...
         // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
+        $dependencies += self::$_instance->_dependency_map[$class];
         // now we need to ensure that the resulting dependencies
         // array only has the entries that are required for the class
         // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+        $dependency_count = count(self::$_instance->_dependency_map[$class]);
         // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
+        self::$_instance->_dependency_map[$class] = $dependency_count
             // then truncate the  final array to match that count
             ? array_slice($dependencies, 0, $dependency_count)
             // otherwise just take the incoming array because nothing previously existed
@@ -247,13 +247,13 @@ 
      */
     public static function register_class_loader($class_name, $loader = 'load_core')
     {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+        if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
             throw new DomainException(
                 esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
             );
         }
         // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (! is_callable($loader)
+        if ( ! is_callable($loader)
             && (
                 strpos($loader, 'load_') !== 0
                 || ! method_exists('EE_Registry', $loader)
@@ -270,8 +270,8 @@ 
             );
         }
         $class_name = self::$_instance->getFqnForAlias($class_name);
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
+            self::$_instance->_class_loaders[$class_name] = $loader;
             return true;
         }
         return false;
@@ -299,7 +299,7 @@ 
         if (strpos($class_name, 'EEM_') === 0) {
             $class_name = 'LEGACY_MODELS';
         }
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
+        return isset($this->_dependency_map[$class_name]) ? true : false;
     }
 
 
@@ -317,7 +317,7 @@ 
             $class_name = 'LEGACY_MODELS';
         }
         $dependency = $this->getFqnForAlias($dependency, $class_name);
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
+        return isset($this->_dependency_map[$class_name][$dependency])
             ? true
             : false;
     }
@@ -338,7 +338,7 @@ 
         }
         $dependency = $this->getFqnForAlias($dependency);
         return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
+            ? $this->_dependency_map[$class_name][$dependency]
             : EE_Dependency_Map::not_registered;
     }
 
@@ -361,7 +361,7 @@ 
             return 'load_core';
         }
         $class_name = $this->getFqnForAlias($class_name);
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
+        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
     }
 
 
@@ -882,7 +882,7 @@ 
     {
         $this->_class_loaders = array(
             // load_core
-            'EE_Dependency_Map'                            => function () {
+            'EE_Dependency_Map'                            => function() {
                 return $this;
             },
             'EE_Capabilities'                              => 'load_core',
@@ -890,13 +890,13 @@ 
             'EE_Front_Controller'                          => 'load_core',
             'EE_Module_Request_Router'                     => 'load_core',
             'EE_Registry'                                  => 'load_core',
-            'EE_Request'                                   => function () {
+            'EE_Request'                                   => function() {
                 return $this->legacy_request;
             },
-            'EventEspresso\core\services\request\Request'  => function () {
+            'EventEspresso\core\services\request\Request'  => function() {
                 return $this->request;
             },
-            'EventEspresso\core\services\request\Response' => function () {
+            'EventEspresso\core\services\request\Response' => function() {
                 return $this->response;
             },
             'EE_Base'                                      => 'load_core',
@@ -929,7 +929,7 @@ 
             'EE_DMS_Core_4_8_0'                            => 'load_dms',
             'EE_DMS_Core_4_9_0'                            => 'load_dms',
             'EE_DMS_Core_4_10_0'                            => 'load_dms',
-            'EE_Messages_Generator'                        => function () {
+            'EE_Messages_Generator'                        => function() {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Generator',
                     array(),
@@ -937,7 +937,7 @@ 
                     false
                 );
             },
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
+            'EE_Messages_Template_Defaults'                => function($arguments = array()) {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Template_Defaults',
                     $arguments,
@@ -946,46 +946,46 @@ 
                 );
             },
             // load_helper
-            'EEH_Parse_Shortcodes'                         => function () {
+            'EEH_Parse_Shortcodes'                         => function() {
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
                     return new EEH_Parse_Shortcodes();
                 }
                 return null;
             },
-            'EE_Template_Config'                           => function () {
+            'EE_Template_Config'                           => function() {
                 return EE_Config::instance()->template_settings;
             },
-            'EE_Currency_Config'                           => function () {
+            'EE_Currency_Config'                           => function() {
                 return EE_Config::instance()->currency;
             },
-            'EE_Registration_Config'                       => function () {
+            'EE_Registration_Config'                       => function() {
                 return EE_Config::instance()->registration;
             },
-            'EE_Core_Config'                               => function () {
+            'EE_Core_Config'                               => function() {
                 return EE_Config::instance()->core;
             },
-            'EventEspresso\core\services\loaders\Loader'   => function () {
+            'EventEspresso\core\services\loaders\Loader'   => function() {
                 return LoaderFactory::getLoader();
             },
-            'EE_Network_Config'                            => function () {
+            'EE_Network_Config'                            => function() {
                 return EE_Network_Config::instance();
             },
-            'EE_Config'                                    => function () {
+            'EE_Config'                                    => function() {
                 return EE_Config::instance();
             },
-            'EventEspresso\core\domain\Domain'             => function () {
+            'EventEspresso\core\domain\Domain'             => function() {
                 return DomainFactory::getEventEspressoCoreDomain();
             },
-            'EE_Admin_Config'                              => function () {
+            'EE_Admin_Config'                              => function() {
                 return EE_Config::instance()->admin;
             },
-            'EE_Organization_Config'                       => function () {
+            'EE_Organization_Config'                       => function() {
                 return EE_Config::instance()->organization;
             },
-            'EE_Network_Core_Config'                       => function () {
+            'EE_Network_Core_Config'                       => function() {
                 return EE_Network_Config::instance()->core;
             },
-            'EE_Environment_Config'                        => function () {
+            'EE_Environment_Config'                        => function() {
                 return EE_Config::instance()->environment;
             },
         );
@@ -1046,7 +1046,7 @@ 
             }
             $this->class_cache->addAlias($fqn, $alias);
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             $this->class_cache->addAlias(
                 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
                 'EventEspresso\core\services\notices\NoticeConverterInterface'

Indentation +1124 added lines, -1124 removed lines

@@ -20,1128 +20,1128 @@
 class EE_Dependency_Map
 {
 
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * When registering a dependency,
-     * this indicates to keep any existing dependencies that already exist,
-     * and simply discard any new dependencies declared in the incoming data
-     */
-    const KEEP_EXISTING_DEPENDENCIES = 0;
-
-    /**
-     * When registering a dependency,
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
-     */
-    const OVERWRITE_DEPENDENCIES = 1;
-
-
-    /**
-     * @type EE_Dependency_Map $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @type RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
-
-    /**
-     * @type ResponseInterface $response
-     */
-    protected $response;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @type array $_dependency_map
-     */
-    protected $_dependency_map = array();
-
-    /**
-     * @type array $_class_loaders
-     */
-    protected $_class_loaders = array();
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    protected function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-        do_action('EE_Dependency_Map____construct', $this);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param ClassInterfaceCache|null $class_cache
-     * @return EE_Dependency_Map
-     */
-    public static function instance(ClassInterfaceCache $class_cache = null)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map
-            && $class_cache instanceof ClassInterfaceCache
-        ) {
-            self::$_instance = new EE_Dependency_Map($class_cache);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param LegacyRequestInterface $legacy_request
-     */
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
-    {
-        $this->legacy_request = $legacy_request;
-    }
-
-
-    /**
-     * @param ResponseInterface $response
-     */
-    public function setResponse(ResponseInterface $response)
-    {
-        $this->response = $response;
-    }
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public static function register_dependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
-    }
-
-
-    /**
-     * Assigns an array of class names and corresponding load sources (new or cached)
-     * to the class specified by the first parameter.
-     * IMPORTANT !!!
-     * The order of elements in the incoming $dependencies array MUST match
-     * the order of the constructor parameters for the class in question.
-     * This is especially important when overriding any existing dependencies that are registered.
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
-     *
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public function registerDependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        $class = trim($class, '\\');
-        $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
-        }
-        // we need to make sure that any aliases used when registering a dependency
-        // get resolved to the correct class name
-        foreach ($dependencies as $dependency => $load_source) {
-            $alias = self::$_instance->getFqnForAlias($dependency);
-            if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
-            ) {
-                unset($dependencies[ $dependency ]);
-                $dependencies[ $alias ] = $load_source;
-                $registered = true;
-            }
-        }
-        // now add our two lists of dependencies together.
-        // using Union (+=) favours the arrays in precedence from left to right,
-        // so $dependencies is NOT overwritten because it is listed first
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
-        // Union is way faster than array_merge() but should be used with caution...
-        // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
-        // now we need to ensure that the resulting dependencies
-        // array only has the entries that are required for the class
-        // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
-        // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
-            // then truncate the  final array to match that count
-            ? array_slice($dependencies, 0, $dependency_count)
-            // otherwise just take the incoming array because nothing previously existed
-            : $dependencies;
-        return $registered;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $loader
-     * @return bool
-     * @throws DomainException
-     */
-    public static function register_class_loader($class_name, $loader = 'load_core')
-    {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
-            throw new DomainException(
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
-            );
-        }
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid loader method on EE_Registry.',
-                        'event_espresso'
-                    ),
-                    $loader
-                )
-            );
-        }
-        $class_name = self::$_instance->getFqnForAlias($class_name);
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map()
-    {
-        return $this->_dependency_map;
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has($class_name = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency, $class_name);
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
-            ? true
-            : false;
-    }
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader($class_name)
-    {
-        // all legacy models use load_model()
-        if (strpos($class_name, 'EEM_') === 0) {
-            return 'load_model';
-        }
-        // EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
-        // perform strpos() first to avoid loading regex every time we load a class
-        if (strpos($class_name, 'EE_CPT_') === 0
-            && preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
-        ) {
-            return 'load_core';
-        }
-        $class_name = $this->getFqnForAlias($class_name);
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
-    }
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders()
-    {
-        return $this->_class_loaders;
-    }
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $fqcn      the class name that should be used (concrete class to replace interface)
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
-     */
-    public function add_alias($fqcn, $alias, $for_class = '')
-    {
-        $this->class_cache->addAlias($fqcn, $alias, $for_class);
-    }
-
-
-    /**
-     * Returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function isAlias($fqn = '', $for_class = '')
-    {
-        return $this->class_cache->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function getFqnForAlias($alias = '', $for_class = '')
-    {
-        return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
-    }
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = array(
-            'EE_Request_Handler'                                                                                          => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_System'                                                                                                   => array(
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Session'                                                                                                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Cart'                                                                                                     => array(
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Front_Controller'                                                                                         => array(
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messenger_Collection_Loader'                                                                              => array(
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Resource_Manager'                                                                                 => array(
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_Factory'                                                                                          => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_messages'                                                                                                 => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Generator'                                                                                       => array(
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Processor'                                                                                       => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Queue'                                                                                           => array(
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Messages_Template_Defaults'                                                                               => array(
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Data_Migration_Class_Base'                                                                                => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_9_0' => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_10_0' => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-                'EE_DMS_Core_4_9_0'                                  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
-                array(),
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
-                'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
-                null,
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'LEGACY_MODELS'                                                                                               => array(
-                null,
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Module_Request_Router'                                                                                    => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Registration_Processor'                                                                                   => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
-                null,
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
-                'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Admin_Transactions_List_Table'                                                                            => array(
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
-                'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\Config'                                                               => array(
-                'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Config'         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'          => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
-                'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
-                'EE_Config'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
-                'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Session'             => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
-                'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
-                'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
-                'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_CPT_Strategy'                                                                                             => array(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
-                'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
-                'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
-                'EEM_Answer' => EE_Dependency_Map::load_from_cache,
-                'EEM_Question' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\CPTs\CptQueryModifier' => array(
-                null,
-                null,
-                null,
-                'EE_Request_Handler'                          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array(
-                'EE_Registry' => EE_Dependency_Map::load_from_cache,
-                'EE_Config' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
-                'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => array(
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => array(
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\editor\blocks\EventAttendees' => array(
-                'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => self::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => self::load_from_cache,
-            ),
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array(
-                'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-                'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => array(
-                'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => array(
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\libraries\rest_api\controllers\model\Read' => array(
-                'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\libraries\rest_api\calculations\Datetime' => array(
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\libraries\rest_api\calculations\Event' => array(
-                'EEM_Event' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\libraries\rest_api\calculations\Registration' => array(
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\services\session\SessionStartHandler' => array(
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_URL_Validation_Strategy' => array(
-                null,
-                null,
-                'EventEspresso\core\services\validators\URLValidator' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\admin_pages\general_settings\OrganizationSettings' => array(
-                'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
-                'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
-                'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\address\CountrySubRegionDao' => array(
-                'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat' => array(
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat' => array(
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-                'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\request\files\FilesDataHandler' => array(
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspressoBatchRequest\BatchRequestProcessor' => [
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder' => [
-                null,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader' => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Attendee'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader' => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader' => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader' => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'  => EE_Dependency_Map::load_from_cache,
-            ],
-        );
-    }
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     */
-    protected function _register_core_class_loaders()
-    {
-        $this->_class_loaders = array(
-            // load_core
-            'EE_Dependency_Map'                            => function () {
-                return $this;
-            },
-            'EE_Capabilities'                              => 'load_core',
-            'EE_Encryption'                                => 'load_core',
-            'EE_Front_Controller'                          => 'load_core',
-            'EE_Module_Request_Router'                     => 'load_core',
-            'EE_Registry'                                  => 'load_core',
-            'EE_Request'                                   => function () {
-                return $this->legacy_request;
-            },
-            'EventEspresso\core\services\request\Request'  => function () {
-                return $this->request;
-            },
-            'EventEspresso\core\services\request\Response' => function () {
-                return $this->response;
-            },
-            'EE_Base'                                      => 'load_core',
-            'EE_Request_Handler'                           => 'load_core',
-            'EE_Session'                                   => 'load_core',
-            'EE_Cron_Tasks'                                => 'load_core',
-            'EE_System'                                    => 'load_core',
-            'EE_Maintenance_Mode'                          => 'load_core',
-            'EE_Register_CPTs'                             => 'load_core',
-            'EE_Admin'                                     => 'load_core',
-            'EE_CPT_Strategy'                              => 'load_core',
-            // load_class
-            'EE_Registration_Processor'                    => 'load_class',
-            // load_lib
-            'EE_Message_Resource_Manager'                  => 'load_lib',
-            'EE_Message_Type_Collection'                   => 'load_lib',
-            'EE_Message_Type_Collection_Loader'            => 'load_lib',
-            'EE_Messenger_Collection'                      => 'load_lib',
-            'EE_Messenger_Collection_Loader'               => 'load_lib',
-            'EE_Messages_Processor'                        => 'load_lib',
-            'EE_Message_Repository'                        => 'load_lib',
-            'EE_Messages_Queue'                            => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'          => 'load_lib',
-            'EE_Message_Template_Group_Collection'         => 'load_lib',
-            'EE_Payment_Method_Manager'                    => 'load_lib',
-            'EE_DMS_Core_4_1_0'                            => 'load_dms',
-            'EE_DMS_Core_4_2_0'                            => 'load_dms',
-            'EE_DMS_Core_4_3_0'                            => 'load_dms',
-            'EE_DMS_Core_4_5_0'                            => 'load_dms',
-            'EE_DMS_Core_4_6_0'                            => 'load_dms',
-            'EE_DMS_Core_4_7_0'                            => 'load_dms',
-            'EE_DMS_Core_4_8_0'                            => 'load_dms',
-            'EE_DMS_Core_4_9_0'                            => 'load_dms',
-            'EE_DMS_Core_4_10_0'                            => 'load_dms',
-            'EE_Messages_Generator'                        => function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    array(),
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            // load_helper
-            'EEH_Parse_Shortcodes'                         => function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                           => function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                           => function () {
-                return EE_Config::instance()->currency;
-            },
-            'EE_Registration_Config'                       => function () {
-                return EE_Config::instance()->registration;
-            },
-            'EE_Core_Config'                               => function () {
-                return EE_Config::instance()->core;
-            },
-            'EventEspresso\core\services\loaders\Loader'   => function () {
-                return LoaderFactory::getLoader();
-            },
-            'EE_Network_Config'                            => function () {
-                return EE_Network_Config::instance();
-            },
-            'EE_Config'                                    => function () {
-                return EE_Config::instance();
-            },
-            'EventEspresso\core\domain\Domain'             => function () {
-                return DomainFactory::getEventEspressoCoreDomain();
-            },
-            'EE_Admin_Config'                              => function () {
-                return EE_Config::instance()->admin;
-            },
-            'EE_Organization_Config'                       => function () {
-                return EE_Config::instance()->organization;
-            },
-            'EE_Network_Core_Config'                       => function () {
-                return EE_Network_Config::instance()->core;
-            },
-            'EE_Environment_Config'                        => function () {
-                return EE_Config::instance()->environment;
-            },
-        );
-    }
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     */
-    protected function _register_core_aliases()
-    {
-        $aliases = array(
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
-            'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
-            'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
-            'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
-            'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
-            'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
-            'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
-            'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
-            'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
-            'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
-            'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
-            'Registration_Processor'                                                       => 'EE_Registration_Processor',
-        );
-        foreach ($aliases as $alias => $fqn) {
-            if (is_array($fqn)) {
-                foreach ($fqn as $class => $for_class) {
-                    $this->class_cache->addAlias($class, $alias, $for_class);
-                }
-                continue;
-            }
-            $this->class_cache->addAlias($fqn, $alias);
-        }
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            $this->class_cache->addAlias(
-                'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
-                'EventEspresso\core\services\notices\NoticeConverterInterface'
-            );
-        }
-    }
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be is_alias()
-     * because it returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @deprecated 4.9.62.p
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function has_alias($fqn = '', $for_class = '')
-    {
-        return $this->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
-     * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @deprecated 4.9.62.p
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function get_alias($alias = '', $for_class = '')
-    {
-        return $this->getFqnForAlias($alias, $for_class);
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to keep any existing dependencies that already exist,
+	 * and simply discard any new dependencies declared in the incoming data
+	 */
+	const KEEP_EXISTING_DEPENDENCIES = 0;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
+	 */
+	const OVERWRITE_DEPENDENCIES = 1;
+
+
+	/**
+	 * @type EE_Dependency_Map $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @type RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
+
+	/**
+	 * @type ResponseInterface $response
+	 */
+	protected $response;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @type array $_dependency_map
+	 */
+	protected $_dependency_map = array();
+
+	/**
+	 * @type array $_class_loaders
+	 */
+	protected $_class_loaders = array();
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	protected function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+		do_action('EE_Dependency_Map____construct', $this);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance(ClassInterfaceCache $class_cache = null)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Dependency_Map
+			&& $class_cache instanceof ClassInterfaceCache
+		) {
+			self::$_instance = new EE_Dependency_Map($class_cache);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param LegacyRequestInterface $legacy_request
+	 */
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
+	{
+		$this->legacy_request = $legacy_request;
+	}
+
+
+	/**
+	 * @param ResponseInterface $response
+	 */
+	public function setResponse(ResponseInterface $response)
+	{
+		$this->response = $response;
+	}
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public static function register_dependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
+	}
+
+
+	/**
+	 * Assigns an array of class names and corresponding load sources (new or cached)
+	 * to the class specified by the first parameter.
+	 * IMPORTANT !!!
+	 * The order of elements in the incoming $dependencies array MUST match
+	 * the order of the constructor parameters for the class in question.
+	 * This is especially important when overriding any existing dependencies that are registered.
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
+	 *
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public function registerDependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		$class = trim($class, '\\');
+		$registered = false;
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
+			self::$_instance->_dependency_map[ $class ] = array();
+		}
+		// we need to make sure that any aliases used when registering a dependency
+		// get resolved to the correct class name
+		foreach ($dependencies as $dependency => $load_source) {
+			$alias = self::$_instance->getFqnForAlias($dependency);
+			if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+			) {
+				unset($dependencies[ $dependency ]);
+				$dependencies[ $alias ] = $load_source;
+				$registered = true;
+			}
+		}
+		// now add our two lists of dependencies together.
+		// using Union (+=) favours the arrays in precedence from left to right,
+		// so $dependencies is NOT overwritten because it is listed first
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
+		// Union is way faster than array_merge() but should be used with caution...
+		// especially with numerically indexed arrays
+		$dependencies += self::$_instance->_dependency_map[ $class ];
+		// now we need to ensure that the resulting dependencies
+		// array only has the entries that are required for the class
+		// so first count how many dependencies were originally registered for the class
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+		// if that count is non-zero (meaning dependencies were already registered)
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
+			// then truncate the  final array to match that count
+			? array_slice($dependencies, 0, $dependency_count)
+			// otherwise just take the incoming array because nothing previously existed
+			: $dependencies;
+		return $registered;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $loader
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function register_class_loader($class_name, $loader = 'load_core')
+	{
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+			throw new DomainException(
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
+			);
+		}
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid loader method on EE_Registry.',
+						'event_espresso'
+					),
+					$loader
+				)
+			);
+		}
+		$class_name = self::$_instance->getFqnForAlias($class_name);
+		if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
+			self::$_instance->_class_loaders[ $class_name ] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map()
+	{
+		return $this->_dependency_map;
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has($class_name = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		return isset($this->_dependency_map[ $class_name ]) ? true : false;
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency, $class_name);
+		return isset($this->_dependency_map[ $class_name ][ $dependency ])
+			? true
+			: false;
+	}
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[ $class_name ][ $dependency ]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader($class_name)
+	{
+		// all legacy models use load_model()
+		if (strpos($class_name, 'EEM_') === 0) {
+			return 'load_model';
+		}
+		// EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
+		// perform strpos() first to avoid loading regex every time we load a class
+		if (strpos($class_name, 'EE_CPT_') === 0
+			&& preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
+		) {
+			return 'load_core';
+		}
+		$class_name = $this->getFqnForAlias($class_name);
+		return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders()
+	{
+		return $this->_class_loaders;
+	}
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $fqcn      the class name that should be used (concrete class to replace interface)
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
+	 */
+	public function add_alias($fqcn, $alias, $for_class = '')
+	{
+		$this->class_cache->addAlias($fqcn, $alias, $for_class);
+	}
+
+
+	/**
+	 * Returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function isAlias($fqn = '', $for_class = '')
+	{
+		return $this->class_cache->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function getFqnForAlias($alias = '', $for_class = '')
+	{
+		return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
+	}
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = array(
+			'EE_Request_Handler'                                                                                          => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_System'                                                                                                   => array(
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Session'                                                                                                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Cart'                                                                                                     => array(
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Front_Controller'                                                                                         => array(
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messenger_Collection_Loader'                                                                              => array(
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Resource_Manager'                                                                                 => array(
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_Factory'                                                                                          => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_messages'                                                                                                 => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Generator'                                                                                       => array(
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Processor'                                                                                       => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Queue'                                                                                           => array(
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Messages_Template_Defaults'                                                                               => array(
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Data_Migration_Class_Base'                                                                                => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_9_0' => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_10_0' => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+				'EE_DMS_Core_4_9_0'                                  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
+				array(),
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
+				'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
+				null,
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'LEGACY_MODELS'                                                                                               => array(
+				null,
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Module_Request_Router'                                                                                    => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Registration_Processor'                                                                                   => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
+				null,
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
+				'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Admin_Transactions_List_Table'                                                                            => array(
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
+				'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\Config'                                                               => array(
+				'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Config'         => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'          => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
+				'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
+				'EE_Config'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
+				'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Session'             => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
+				'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
+				'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
+				'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_CPT_Strategy'                                                                                             => array(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
+				'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
+				'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
+				'EEM_Answer' => EE_Dependency_Map::load_from_cache,
+				'EEM_Question' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\CPTs\CptQueryModifier' => array(
+				null,
+				null,
+				null,
+				'EE_Request_Handler'                          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array(
+				'EE_Registry' => EE_Dependency_Map::load_from_cache,
+				'EE_Config' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
+				'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => array(
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => array(
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\editor\blocks\EventAttendees' => array(
+				'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => self::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => self::load_from_cache,
+			),
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array(
+				'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+				'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => array(
+				'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => array(
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\libraries\rest_api\controllers\model\Read' => array(
+				'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\libraries\rest_api\calculations\Datetime' => array(
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\libraries\rest_api\calculations\Event' => array(
+				'EEM_Event' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\libraries\rest_api\calculations\Registration' => array(
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\services\session\SessionStartHandler' => array(
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_URL_Validation_Strategy' => array(
+				null,
+				null,
+				'EventEspresso\core\services\validators\URLValidator' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\admin_pages\general_settings\OrganizationSettings' => array(
+				'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
+				'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
+				'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\address\CountrySubRegionDao' => array(
+				'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat' => array(
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat' => array(
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+				'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\request\files\FilesDataHandler' => array(
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspressoBatchRequest\BatchRequestProcessor' => [
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder' => [
+				null,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader' => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Attendee'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader' => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader' => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader' => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'  => EE_Dependency_Map::load_from_cache,
+			],
+		);
+	}
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 */
+	protected function _register_core_class_loaders()
+	{
+		$this->_class_loaders = array(
+			// load_core
+			'EE_Dependency_Map'                            => function () {
+				return $this;
+			},
+			'EE_Capabilities'                              => 'load_core',
+			'EE_Encryption'                                => 'load_core',
+			'EE_Front_Controller'                          => 'load_core',
+			'EE_Module_Request_Router'                     => 'load_core',
+			'EE_Registry'                                  => 'load_core',
+			'EE_Request'                                   => function () {
+				return $this->legacy_request;
+			},
+			'EventEspresso\core\services\request\Request'  => function () {
+				return $this->request;
+			},
+			'EventEspresso\core\services\request\Response' => function () {
+				return $this->response;
+			},
+			'EE_Base'                                      => 'load_core',
+			'EE_Request_Handler'                           => 'load_core',
+			'EE_Session'                                   => 'load_core',
+			'EE_Cron_Tasks'                                => 'load_core',
+			'EE_System'                                    => 'load_core',
+			'EE_Maintenance_Mode'                          => 'load_core',
+			'EE_Register_CPTs'                             => 'load_core',
+			'EE_Admin'                                     => 'load_core',
+			'EE_CPT_Strategy'                              => 'load_core',
+			// load_class
+			'EE_Registration_Processor'                    => 'load_class',
+			// load_lib
+			'EE_Message_Resource_Manager'                  => 'load_lib',
+			'EE_Message_Type_Collection'                   => 'load_lib',
+			'EE_Message_Type_Collection_Loader'            => 'load_lib',
+			'EE_Messenger_Collection'                      => 'load_lib',
+			'EE_Messenger_Collection_Loader'               => 'load_lib',
+			'EE_Messages_Processor'                        => 'load_lib',
+			'EE_Message_Repository'                        => 'load_lib',
+			'EE_Messages_Queue'                            => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'          => 'load_lib',
+			'EE_Message_Template_Group_Collection'         => 'load_lib',
+			'EE_Payment_Method_Manager'                    => 'load_lib',
+			'EE_DMS_Core_4_1_0'                            => 'load_dms',
+			'EE_DMS_Core_4_2_0'                            => 'load_dms',
+			'EE_DMS_Core_4_3_0'                            => 'load_dms',
+			'EE_DMS_Core_4_5_0'                            => 'load_dms',
+			'EE_DMS_Core_4_6_0'                            => 'load_dms',
+			'EE_DMS_Core_4_7_0'                            => 'load_dms',
+			'EE_DMS_Core_4_8_0'                            => 'load_dms',
+			'EE_DMS_Core_4_9_0'                            => 'load_dms',
+			'EE_DMS_Core_4_10_0'                            => 'load_dms',
+			'EE_Messages_Generator'                        => function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					array(),
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			// load_helper
+			'EEH_Parse_Shortcodes'                         => function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                           => function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                           => function () {
+				return EE_Config::instance()->currency;
+			},
+			'EE_Registration_Config'                       => function () {
+				return EE_Config::instance()->registration;
+			},
+			'EE_Core_Config'                               => function () {
+				return EE_Config::instance()->core;
+			},
+			'EventEspresso\core\services\loaders\Loader'   => function () {
+				return LoaderFactory::getLoader();
+			},
+			'EE_Network_Config'                            => function () {
+				return EE_Network_Config::instance();
+			},
+			'EE_Config'                                    => function () {
+				return EE_Config::instance();
+			},
+			'EventEspresso\core\domain\Domain'             => function () {
+				return DomainFactory::getEventEspressoCoreDomain();
+			},
+			'EE_Admin_Config'                              => function () {
+				return EE_Config::instance()->admin;
+			},
+			'EE_Organization_Config'                       => function () {
+				return EE_Config::instance()->organization;
+			},
+			'EE_Network_Core_Config'                       => function () {
+				return EE_Network_Config::instance()->core;
+			},
+			'EE_Environment_Config'                        => function () {
+				return EE_Config::instance()->environment;
+			},
+		);
+	}
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 */
+	protected function _register_core_aliases()
+	{
+		$aliases = array(
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
+			'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
+			'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
+			'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
+			'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
+			'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
+			'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
+			'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
+			'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
+			'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
+			'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
+			'Registration_Processor'                                                       => 'EE_Registration_Processor',
+		);
+		foreach ($aliases as $alias => $fqn) {
+			if (is_array($fqn)) {
+				foreach ($fqn as $class => $for_class) {
+					$this->class_cache->addAlias($class, $alias, $for_class);
+				}
+				continue;
+			}
+			$this->class_cache->addAlias($fqn, $alias);
+		}
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			$this->class_cache->addAlias(
+				'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
+				'EventEspresso\core\services\notices\NoticeConverterInterface'
+			);
+		}
+	}
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be is_alias()
+	 * because it returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @deprecated 4.9.62.p
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function has_alias($fqn = '', $for_class = '')
+	{
+		return $this->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
+	 * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @deprecated 4.9.62.p
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function get_alias($alias = '', $for_class = '')
+	{
+		return $this->getFqnForAlias($alias, $for_class);
+	}
 }

core/db_models/EEM_Event.model.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidInterfaceException;
-use EventEspresso\core\services\orm\ModelFieldFactory;
 
 /**
  * EEM_Event Model

Spacing +17 added lines, -17 removed lines

@@ -278,7 +278,7 @@ 
             'WP_User'                => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password = '';
         parent::__construct($timezone);
     }
@@ -371,7 +371,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -405,7 +405,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -448,7 +448,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -861,11 +861,11 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
+                $questions[$qg->ID()] = $qg->model_field_array();
+                $questions[$qg->ID()]['QSG_questions'] = array();
                 foreach ($qsts as $qst) {
                     if ($qst->is_system_question()) {
                         continue;
@@ -879,26 +879,26 @@ 
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
                     $qst_name = $qstn_id = $qst->ID();
                     $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($qst->display_text());
                     $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
                     // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
                     if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
                         $QSOs = $qst->options(true, $answer->value());
                         if (is_array($QSOs)) {
                             foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
                             }
                         }
                     }

Indentation +909 added lines, -909 removed lines

@@ -15,913 +15,913 @@
 class EEM_Event extends EEM_CPT_Base
 {
 
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            array(
-                EEM_Event::cancelled => array(
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ),
-                EEM_Event::postponed => array(
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ),
-                EEM_Event::sold_out  => array(
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ),
-            )
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables = array(
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        );
-        $this->_fields = array(
-            'Event_CPT'  => array(
-                'EVT_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__('Post ID for Event', 'event_espresso')
-                ),
-                'EVT_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_slug'       => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__('Event Slug', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_short_desc' => new EE_Simple_HTML_Field(
-                    'post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'EVT_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field(
-                    'post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false,
-                    'draft',
-                    $this->_custom_stati
-                ),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    __('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'EVT_desc',
-                        'EVT_short_desc',
-                        'EVT_display_desc',
-                        'EVT_display_ticket_selector',
-                        'EVT_visible_on',
-                        'EVT_additional_limit',
-                        'EVT_default_registration_status',
-                        'EVT_member_only',
-                        'EVT_phone',
-                        'EVT_allow_overflow',
-                        'EVT_timezone_string',
-                        'EVT_external_URL',
-                        'EVT_donations'
-                    )
-                )
-            ),
-            'Event_Meta' => array(
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field(
-                    'EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
-                    false
-                ),
-                'EVT_display_desc'                => new EE_Boolean_Field(
-                    'EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field(
-                    'EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_visible_on'                  => new EE_Datetime_Field(
-                    'EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    true,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                    false,
-                    EEM_Event::$_default_reg_status,
-                    EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field(
-                    'EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_phone'                       => new EE_Plain_Text_Field(
-                    'EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_allow_overflow'              => new EE_Boolean_Field(
-                    'EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field(
-                    'EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_external_URL'                => new EE_Plain_Text_Field(
-                    'EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
-                    true
-                ),
-                'EVT_donations'                   => new EE_Boolean_Field(
-                    'EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * @param string $default_reg_status
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                array('QSG_deleted' => false),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array('EVT_ID' => $EVT_ID),
-            )
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $query_params = [
-            [
-                'EVT_ID' => $EVT_ID,
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true
-            ]
-        ];
-        if ($for_primary_attendee) {
-            $query_params[0]['EQG_primary'] = true;
-        } else {
-            $query_params[0]['EQG_additional'] = true;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID'      => $EVT_ID,
-                    'Event_Question_Group.'
-                        . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                            $registration->is_primary_registrant()
-                        ) => true
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            array(
-                array(
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ),
-                'order_by' => 'QST_order',
-            )
-        );
-    }
-
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            array(
-                array(
-                    'Question.QST_ID' => array('IN', $QST_IDs),
-                    'QSO_deleted'     => false,
-                ),
-                'order_by' => 'QSO_ID',
-            )
-        );
-    }
-
-
-
-
-
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = array(
-            'Datetime.DTT_EVT_end' => array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ),
-        );
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = array(
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
-            'EVT_ID'               => array('NOT IN', $event_ids),
-        );
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param  array   $query_params An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param  boolean $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = array('!=', 'publish');
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *             EE_Registration_Custom_Questions_Form located in
-     *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     * @param    EE_Registration $registration (so existing answers for registration are included)
-     * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @throws EE_Error
-     * @return    array
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(__(
-                'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                'event_espresso'
-            ));
-        }
-        $questions = array();
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer = EEM_Answer::instance()->get_one(array(
-                        array(
-                            'QST_ID' => $qst->ID(),
-                            'REG_ID' => $registration->ID(),
-                        ),
-                    ));
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
-                    $qst_name = $qstn_id = $qst->ID();
-                    $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($qst->display_text());
-                    $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			array(
+				EEM_Event::cancelled => array(
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				),
+				EEM_Event::postponed => array(
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				),
+				EEM_Event::sold_out  => array(
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				),
+			)
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables = array(
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		);
+		$this->_fields = array(
+			'Event_CPT'  => array(
+				'EVT_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__('Post ID for Event', 'event_espresso')
+				),
+				'EVT_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__('Event Name', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_slug'       => new EE_Slug_Field(
+					'post_name',
+					esc_html__('Event Slug', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_short_desc' => new EE_Simple_HTML_Field(
+					'post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0
+				),
+				'EVT_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field(
+					'post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false,
+					'draft',
+					$this->_custom_stati
+				),
+				'password' => new EE_Password_Field(
+					'post_password',
+					__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'EVT_desc',
+						'EVT_short_desc',
+						'EVT_display_desc',
+						'EVT_display_ticket_selector',
+						'EVT_visible_on',
+						'EVT_additional_limit',
+						'EVT_default_registration_status',
+						'EVT_member_only',
+						'EVT_phone',
+						'EVT_allow_overflow',
+						'EVT_timezone_string',
+						'EVT_external_URL',
+						'EVT_donations'
+					)
+				)
+			),
+			'Event_Meta' => array(
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field(
+					'EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'),
+					false
+				),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
+					'EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
+					false
+				),
+				'EVT_display_desc'                => new EE_Boolean_Field(
+					'EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field(
+					'EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_visible_on'                  => new EE_Datetime_Field(
+					'EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					true,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'),
+					false,
+					EEM_Event::$_default_reg_status,
+					EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field(
+					'EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_phone'                       => new EE_Plain_Text_Field(
+					'EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_allow_overflow'              => new EE_Boolean_Field(
+					'EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field(
+					'EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_external_URL'                => new EE_Plain_Text_Field(
+					'EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
+					true
+				),
+				'EVT_donations'                   => new EE_Boolean_Field(
+					'EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * @param string $default_reg_status
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				array('QSG_deleted' => false),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array('EVT_ID' => $EVT_ID),
+			)
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$query_params = [
+			[
+				'EVT_ID' => $EVT_ID,
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true
+			]
+		];
+		if ($for_primary_attendee) {
+			$query_params[0]['EQG_primary'] = true;
+		} else {
+			$query_params[0]['EQG_additional'] = true;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID'      => $EVT_ID,
+					'Event_Question_Group.'
+						. EEM_Event_Question_Group::instance()->fieldNameForContext(
+							$registration->is_primary_registrant()
+						) => true
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			array(
+				array(
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				),
+				'order_by' => 'QST_order',
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			array(
+				array(
+					'Question.QST_ID' => array('IN', $QST_IDs),
+					'QSO_deleted'     => false,
+				),
+				'order_by' => 'QSO_ID',
+			)
+		);
+	}
+
+
+
+
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = array(
+			'Datetime.DTT_EVT_end' => array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			),
+		);
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = array(
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
+			'EVT_ID'               => array('NOT IN', $event_ids),
+		);
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param  array   $query_params An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = array('!=', 'publish');
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *             EE_Registration_Custom_Questions_Form located in
+	 *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 * @param    EE_Registration $registration (so existing answers for registration are included)
+	 * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @throws EE_Error
+	 * @return    array
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(__(
+				'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+				'event_espresso'
+			));
+		}
+		$questions = array();
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts = $qg->questions();
+				$questions[ $qg->ID() ] = $qg->model_field_array();
+				$questions[ $qg->ID() ]['QSG_questions'] = array();
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer = EEM_Answer::instance()->get_one(array(
+						array(
+							'QST_ID' => $qst->ID(),
+							'REG_ID' => $registration->ID(),
+						),
+					));
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
+					$qst_name = $qstn_id = $qst->ID();
+					$ans_id = $answer->ID();
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($qst->display_text());
+					$input_class = '';
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $qst_name;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

admin_pages/registration_form/espresso_events_Registration_Form_Hooks.class.php

Indentation +192 added lines, -192 removed lines

@@ -16,210 +16,210 @@
 class espresso_events_Registration_Form_Hooks extends EE_Admin_Hooks
 {
 
-    /**
-     * @var EE_Event|null
-     */
-    protected $_event;
-
-
-    protected function _set_hooks_properties()
-    {
-
-        $this->_name = 'registration_form';
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'primary_questions',
-                'label'      => esc_html__('Questions for Primary Registrant', 'event_espresso'),
-                'priority'   => 'default',
-                'context'    => 'side',
-            ),
-        );
-
-        // hook into the handler for saving question groups
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'modify_callbacks'),
-            10
-        );
-
-        // hook into revision restores (we're hooking into the global action because EE_Admin_Hooks classes are already
-        // restricted by page)
-        add_action('AHEE_EE_Admin_Page_CPT__restore_revision', array($this, 'restore_revision'), 10, 2);
-    }
-
-
-    /**
-     * Callback for FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks hook
-     *
-     * @param $callbacks
-     * @return array
-     */
-    public function modify_callbacks($callbacks)
-    {
-        // now let's add the question group callback
-        $callbacks[] = array($this, 'primary_question_group_update');
-        return $callbacks;
-    }
-
-
-    /**
-     * Hooked into revision restores.
-     *
-     * @param $post_id
-     * @param $revision_id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $EVT_MDL = EE_Registry::instance()->load_model('Event');
-        $post_evt = $EVT_MDL->get_one_by_ID($post_id);
-        // restore revision for primary questions
-        $post_evt->restore_revision(
-            $revision_id,
-            ['Question_Group'],
-            ['Question_Group' => ['Event_Question_Group.EQG_primary' => true]]
-        );
-        return $post_evt;
-    }
-
-
-    /**
-     * Content of metabox.
-     *
-     * @param $post_id
-     * @param $post
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function primary_questions($post_id, $post)
-    {
-        $this->_event = $this->_adminpage_obj->get_event_object();
-        $event_id = $this->_event->ID();
-        ?>
+	/**
+	 * @var EE_Event|null
+	 */
+	protected $_event;
+
+
+	protected function _set_hooks_properties()
+	{
+
+		$this->_name = 'registration_form';
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'primary_questions',
+				'label'      => esc_html__('Questions for Primary Registrant', 'event_espresso'),
+				'priority'   => 'default',
+				'context'    => 'side',
+			),
+		);
+
+		// hook into the handler for saving question groups
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'modify_callbacks'),
+			10
+		);
+
+		// hook into revision restores (we're hooking into the global action because EE_Admin_Hooks classes are already
+		// restricted by page)
+		add_action('AHEE_EE_Admin_Page_CPT__restore_revision', array($this, 'restore_revision'), 10, 2);
+	}
+
+
+	/**
+	 * Callback for FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks hook
+	 *
+	 * @param $callbacks
+	 * @return array
+	 */
+	public function modify_callbacks($callbacks)
+	{
+		// now let's add the question group callback
+		$callbacks[] = array($this, 'primary_question_group_update');
+		return $callbacks;
+	}
+
+
+	/**
+	 * Hooked into revision restores.
+	 *
+	 * @param $post_id
+	 * @param $revision_id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$EVT_MDL = EE_Registry::instance()->load_model('Event');
+		$post_evt = $EVT_MDL->get_one_by_ID($post_id);
+		// restore revision for primary questions
+		$post_evt->restore_revision(
+			$revision_id,
+			['Question_Group'],
+			['Question_Group' => ['Event_Question_Group.EQG_primary' => true]]
+		);
+		return $post_evt;
+	}
+
+
+	/**
+	 * Content of metabox.
+	 *
+	 * @param $post_id
+	 * @param $post
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function primary_questions($post_id, $post)
+	{
+		$this->_event = $this->_adminpage_obj->get_event_object();
+		$event_id = $this->_event->ID();
+		?>
         <div class="inside">
             <p><strong>
                     <?php _e('Question Groups', 'event_espresso'); ?>
                 </strong><br/>
                 <?php
-                printf(
-                    esc_html__(
-                        'Add a pre-populated %1$sgroup of questions%2$s to your event. The personal information group is required for all events',
-                        'event_espresso'
-                    ),
-                    '<a href="admin.php?page=espresso_registration_form" target="_blank">',
-                    '</a>'
-                )
-                ?>
+				printf(
+					esc_html__(
+						'Add a pre-populated %1$sgroup of questions%2$s to your event. The personal information group is required for all events',
+						'event_espresso'
+					),
+					'<a href="admin.php?page=espresso_registration_form" target="_blank">',
+					'</a>'
+				)
+				?>
             </p>
             <?php
 
-            $qsg_where['QSG_deleted'] = false;
-            $query_params = apply_filters(
-                'FHEE__espresso_events_Registration_Form_Hooks__primary_questions__question_group_query_parameters',
-                array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
-            );
-            $QSGs = EEM_Question_Group::instance()->get_all($query_params);
-            $EQGs = ! empty($event_id)
-                ? $this->_event->get_many_related(
-                    'Question_Group',
-                    [['Event_Question_Group.EQG_primary' => true]]
-                )
-                : array();
-            $EQGids = array_keys($EQGs);
-
-            if (! empty($QSGs)) {
-                $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
-                foreach ($QSGs as $QSG) {
-                    $checked = in_array($QSG->ID(), $EQGids, true)
-                               || $QSG->get('QSG_system') === 1
-                        ? ' checked="checked"'
-                        : '';
-                    $visibility = $QSG->get('QSG_system') === 1
-                        ? ' style="visibility:hidden"'
-                        : '';
-                    $edit_query_args = $this->_adminpage_obj->is_caf() ? array(
-                        'action' => 'edit_question_group',
-                        'QSG_ID' => $QSG->ID(),
-                    ) : array('action' => 'question_groups');
-                    $edit_link = EE_Admin_Page::add_query_args_and_nonce(
-                        $edit_query_args,
-                        EE_FORMS_ADMIN_URL
-                    );
-
-                    $html .= '
+			$qsg_where['QSG_deleted'] = false;
+			$query_params = apply_filters(
+				'FHEE__espresso_events_Registration_Form_Hooks__primary_questions__question_group_query_parameters',
+				array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
+			);
+			$QSGs = EEM_Question_Group::instance()->get_all($query_params);
+			$EQGs = ! empty($event_id)
+				? $this->_event->get_many_related(
+					'Question_Group',
+					[['Event_Question_Group.EQG_primary' => true]]
+				)
+				: array();
+			$EQGids = array_keys($EQGs);
+
+			if (! empty($QSGs)) {
+				$html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
+				foreach ($QSGs as $QSG) {
+					$checked = in_array($QSG->ID(), $EQGids, true)
+							   || $QSG->get('QSG_system') === 1
+						? ' checked="checked"'
+						: '';
+					$visibility = $QSG->get('QSG_system') === 1
+						? ' style="visibility:hidden"'
+						: '';
+					$edit_query_args = $this->_adminpage_obj->is_caf() ? array(
+						'action' => 'edit_question_group',
+						'QSG_ID' => $QSG->ID(),
+					) : array('action' => 'question_groups');
+					$edit_link = EE_Admin_Page::add_query_args_and_nonce(
+						$edit_query_args,
+						EE_FORMS_ADMIN_URL
+					);
+
+					$html .= '
 					<p id="event-question-group-' . $QSG->ID() . '">
 						<input value="' . $QSG->ID() . '" type="checkbox"'
-                             . $visibility
-                             . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
+							 . $visibility
+							 . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
 						<a href="' . $edit_link . '" title="'
-                             . sprintf(
-                                 esc_attr__('Edit %s Group', 'event_espresso'),
-                                 $QSG->get('QSG_name')
-                             )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+							 . sprintf(
+								 esc_attr__('Edit %s Group', 'event_espresso'),
+								 $QSG->get('QSG_name')
+							 )
+							 . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
 					</p>';
-                }
-                $html .= count($QSGs) > 10 ? '</div>' : '';
-
-                echo $html;
-            } else {
-                esc_html_e(
-                    'There seems to be a problem with your questions. Please contact support@eventespresso.com',
-                    'event_espresso'
-                );
-            }
-            do_action('AHEE_event_editor_questions_notice');
-            ?>
+				}
+				$html .= count($QSGs) > 10 ? '</div>' : '';
+
+				echo $html;
+			} else {
+				esc_html_e(
+					'There seems to be a problem with your questions. Please contact support@eventespresso.com',
+					'event_espresso'
+				);
+			}
+			do_action('AHEE_event_editor_questions_notice');
+			?>
         </div>
         <?php
-    }
-
-
-    /**
-     * @param EE_Event $evtobj
-     * @param array    $data
-     * @return bool
-     * @throws EE_Error
-     */
-    public function primary_question_group_update($evtobj, $data)
-    {
-        $question_groups = ! empty($data['question_groups']) ? (array) $data['question_groups'] : array();
-        $added_qgs = array_keys($question_groups);
-        $success = array();
-
-        // let's get all current question groups associated with this event.
-        $current_qgs = $evtobj->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_primary' => true]]
-        );
-        $current_qgs = array_keys($current_qgs); // we just want the ids
-
-        // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $id => $val) {
-                // add to event
-                if ($val) {
-                    $qg = $evtobj->_add_relation_to($id, 'Question_Group', ['EQG_primary' => true]);
-                }
-                $success[] = ! empty($qg) ? 1 : 0;
-            }
-        }
-
-        // wait a minute... are there question groups missing in the saved groups that ARE with the current event?
-        $removed_qgs = array_diff($current_qgs, $added_qgs);
-
-        foreach ($removed_qgs as $qgid) {
-            $qg = $evtobj->_remove_relation_to($qgid, 'Question_Group', ['EQG_primary' => true]);
-            $success[] = ! empty($qg) ? 1 : 0;
-        }
-        return in_array(0, $success, true) ? false : true;
-    }
+	}
+
+
+	/**
+	 * @param EE_Event $evtobj
+	 * @param array    $data
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function primary_question_group_update($evtobj, $data)
+	{
+		$question_groups = ! empty($data['question_groups']) ? (array) $data['question_groups'] : array();
+		$added_qgs = array_keys($question_groups);
+		$success = array();
+
+		// let's get all current question groups associated with this event.
+		$current_qgs = $evtobj->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_primary' => true]]
+		);
+		$current_qgs = array_keys($current_qgs); // we just want the ids
+
+		// now let's get the groups selected in the editor and update (IF we have data)
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $id => $val) {
+				// add to event
+				if ($val) {
+					$qg = $evtobj->_add_relation_to($id, 'Question_Group', ['EQG_primary' => true]);
+				}
+				$success[] = ! empty($qg) ? 1 : 0;
+			}
+		}
+
+		// wait a minute... are there question groups missing in the saved groups that ARE with the current event?
+		$removed_qgs = array_diff($current_qgs, $added_qgs);
+
+		foreach ($removed_qgs as $qgid) {
+			$qg = $evtobj->_remove_relation_to($qgid, 'Question_Group', ['EQG_primary' => true]);
+			$success[] = ! empty($qg) ? 1 : 0;
+		}
+		return in_array(0, $success, true) ? false : true;
+	}
 }

core/db_models/EEM_Event_Question_Group.model.php

Spacing +4 added lines, -4 removed lines

@@ -32,10 +32,10 @@
         );
         // this model is generally available for reading
         $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
         parent::__construct($timezone);
     }
 

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
      * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
      * EQG_additional.
      * @since 4.10.0.p
-     * @param string|boolean|int $context
+     * @param boolean $context
      * @return string
      */
     public function fieldNameForContext($context)

Indentation +64 added lines, -64 removed lines

@@ -7,72 +7,72 @@
  */
 class EEM_Event_Question_Group extends EEM_Base
 {
-    /**
-     * Name of the field indicating an event should use the question group for the primary attendee
-     */
-    const PRIMARY = 'EQG_primary';
+	/**
+	 * Name of the field indicating an event should use the question group for the primary attendee
+	 */
+	const PRIMARY = 'EQG_primary';
 
-    /**
-     * Name of hte field indicating an event should use the question group for additional attendees
-     */
-    const ADDITIONAL = 'EQG_additional';
+	/**
+	 * Name of hte field indicating an event should use the question group for additional attendees
+	 */
+	const ADDITIONAL = 'EQG_additional';
 
-    // private instance of the Event_Question_Group object
-    protected static $_instance = null;
+	// private instance of the Event_Question_Group object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Event to Question Group Link', 'event_espresso');
-        $this->plural_item = __('Event to Question Group Links', 'event_espresso');
-        $this->_tables = array(
-            'Event_Question_Group'=>new EE_Primary_Table('esp_event_question_group', 'EQG_ID')
-        );
-        $this->_fields = array(
-            'Event_Question_Group'=>array(
-                'EQG_ID'=>new EE_Primary_Key_Int_Field('EQG_ID', __('Event to Question Group Link ID', 'event_espresso')),
-                'EVT_ID'=>new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
-                'QSG_ID'=>new EE_Foreign_Key_Int_Field('QSG_ID', __('Question Group Id', 'event_espresso'), false, 0, 'Question_Group'),
-                'EQG_primary'=>new EE_Boolean_Field('EQG_primary', __('Flag indicating question is only for primary attendees', 'event_espresso'), false, false),
-                'EQG_additional'=>new EE_Boolean_Field('EQG_additional', __('Flag indicating question is only for additional attendees', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Event'=>new EE_Belongs_To_Relation(),
-            'Question_Group'=>new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Event to Question Group Link', 'event_espresso');
+		$this->plural_item = __('Event to Question Group Links', 'event_espresso');
+		$this->_tables = array(
+			'Event_Question_Group'=>new EE_Primary_Table('esp_event_question_group', 'EQG_ID')
+		);
+		$this->_fields = array(
+			'Event_Question_Group'=>array(
+				'EQG_ID'=>new EE_Primary_Key_Int_Field('EQG_ID', __('Event to Question Group Link ID', 'event_espresso')),
+				'EVT_ID'=>new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
+				'QSG_ID'=>new EE_Foreign_Key_Int_Field('QSG_ID', __('Question Group Id', 'event_espresso'), false, 0, 'Question_Group'),
+				'EQG_primary'=>new EE_Boolean_Field('EQG_primary', __('Flag indicating question is only for primary attendees', 'event_espresso'), false, false),
+				'EQG_additional'=>new EE_Boolean_Field('EQG_additional', __('Flag indicating question is only for additional attendees', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Event'=>new EE_Belongs_To_Relation(),
+			'Question_Group'=>new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$path_to_event = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
+		parent::__construct($timezone);
+	}
 
-    /**
-     * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
-     * this is concerning primary attendees or additional attendees.
-     * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
-     * EQG_additional.
-     * @since 4.10.0.p
-     * @param string|boolean|int $context
-     * @return string
-     */
-    public function fieldNameForContext($context)
-    {
-        // Basically do a strict switch statement.
-        switch (true) {
-            case $context === 'additional':
-            case $context === false:
-            case $context === 0:
-                $field_name = EEM_Event_Question_Group::ADDITIONAL;
-                break;
-            case $context === 'primary':
-            case $context === true:
-            case $context === 1:
-            default:
-                $field_name = EEM_Event_Question_Group::PRIMARY;
-        }
-        return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
-    }
+	/**
+	 * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
+	 * this is concerning primary attendees or additional attendees.
+	 * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
+	 * EQG_additional.
+	 * @since 4.10.0.p
+	 * @param string|boolean|int $context
+	 * @return string
+	 */
+	public function fieldNameForContext($context)
+	{
+		// Basically do a strict switch statement.
+		switch (true) {
+			case $context === 'additional':
+			case $context === false:
+			case $context === 0:
+				$field_name = EEM_Event_Question_Group::ADDITIONAL;
+				break;
+			case $context === 'primary':
+			case $context === true:
+			case $context === 1:
+			default:
+				$field_name = EEM_Event_Question_Group::PRIMARY;
+		}
+		return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
+	}
 }

caffeinated/admin/extend/registration_form/espresso_events_Registration_Form_Hooks_Extend.class.php

Indentation +189 added lines, -189 removed lines

@@ -16,208 +16,208 @@
 class espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks
 {
 
-    /**
-     * extending the properties set in espresso_events_Registration_From_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        $this->_metaboxes = array_merge(
-            $this->_metaboxes,
-            array(
-                1 => array(
-                    'page_route' => array('create_new', 'edit'),
-                    'func'       => 'additional_questions',
-                    'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
-                    'priority'   => 'default',
-                    'context'    => 'side',
-                ),
-            )
-        );
-        $this->_scripts_styles = array(
-            'registers' => array(
-                'extended-event-editor' => array(
-                    'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
-                                 . 'registration_form/assets/event-editor-question-groups.js',
-                    'depends' => array('jquery'),
-                ),
-            ),
-            'enqueues'  => array(
-                'extended-event-editor' => array('edit', 'create_new'),
-            ),
-        );
-    }
-
-
-    /**
-     * @param Callable[] $callbacks
-     * @return array
-     */
-    public function modify_callbacks($callbacks)
-    {
-        $callbacks = parent::modify_callbacks($callbacks);
-        $callbacks[] = array($this, 'additional_question_group_update');
-        return $callbacks;
-    }
-
-
-    /**
-     * Call back hooked into revision restores.
-     *
-     * @param $post_id
-     * @param $revision_id
-     * @return EE_Base_Class|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $post_evt = parent::restore_revision($post_id, $revision_id);
-
-        // restore revision for additional questions
-        $post_evt->restore_revision(
-            $revision_id,
-            ['Question_Group'],
-            [
-                'Question_Group' => ['Event_Question_Group.EQG_additional' => true],
-            ]
-        );
-    }
-
-
-    /**
-     * @param $post_id
-     * @param $post
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function additional_questions($post_id, $post)
-    {
-        $this->_event = $this->_adminpage_obj->get_event_object();
-        $event_id = $this->_event->ID();
-        ?>
+	/**
+	 * extending the properties set in espresso_events_Registration_From_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		$this->_metaboxes = array_merge(
+			$this->_metaboxes,
+			array(
+				1 => array(
+					'page_route' => array('create_new', 'edit'),
+					'func'       => 'additional_questions',
+					'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
+					'priority'   => 'default',
+					'context'    => 'side',
+				),
+			)
+		);
+		$this->_scripts_styles = array(
+			'registers' => array(
+				'extended-event-editor' => array(
+					'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
+								 . 'registration_form/assets/event-editor-question-groups.js',
+					'depends' => array('jquery'),
+				),
+			),
+			'enqueues'  => array(
+				'extended-event-editor' => array('edit', 'create_new'),
+			),
+		);
+	}
+
+
+	/**
+	 * @param Callable[] $callbacks
+	 * @return array
+	 */
+	public function modify_callbacks($callbacks)
+	{
+		$callbacks = parent::modify_callbacks($callbacks);
+		$callbacks[] = array($this, 'additional_question_group_update');
+		return $callbacks;
+	}
+
+
+	/**
+	 * Call back hooked into revision restores.
+	 *
+	 * @param $post_id
+	 * @param $revision_id
+	 * @return EE_Base_Class|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$post_evt = parent::restore_revision($post_id, $revision_id);
+
+		// restore revision for additional questions
+		$post_evt->restore_revision(
+			$revision_id,
+			['Question_Group'],
+			[
+				'Question_Group' => ['Event_Question_Group.EQG_additional' => true],
+			]
+		);
+	}
+
+
+	/**
+	 * @param $post_id
+	 * @param $post
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function additional_questions($post_id, $post)
+	{
+		$this->_event = $this->_adminpage_obj->get_event_object();
+		$event_id = $this->_event->ID();
+		?>
         <div class="inside">
             <p><strong>
                     <?php _e('Question Groups', 'event_espresso'); ?>
                 </strong><br/>
                 <?php
-                printf(
-                    esc_html__(
-                        'Add a pre-populated %1$sgroup of questions%2$s to your event.',
-                        'event_espresso'
-                    ),
-                    '<a href="admin.php?page=espresso_registration_form" target="_blank">',
-                    '</a>'
-                );
-                ?>
+				printf(
+					esc_html__(
+						'Add a pre-populated %1$sgroup of questions%2$s to your event.',
+						'event_espresso'
+					),
+					'<a href="admin.php?page=espresso_registration_form" target="_blank">',
+					'</a>'
+				);
+				?>
             </p>
             <?php
 
-            $qsg_where['QSG_deleted'] = false;
-            $query_params = apply_filters(
-                'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
-                array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
-            );
-            $QSGs = EEM_Question_Group::instance()->get_all($query_params);
-            $EQGs = ! empty($event_id)
-                ? $this->_event->get_many_related(
-                    'Question_Group',
-                    [['Event_Question_Group.EQG_additional' => true]]
-                )
-                : [];
-            $EQGids = array_keys($EQGs);
-
-            if (! empty($QSGs)) {
-                $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
-                foreach ($QSGs as $QSG) {
-                    $checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
-                    $edit_link = EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_question_group',
-                            'QSG_ID' => $QSG->ID(),
-                        ),
-                        EE_FORMS_ADMIN_URL
-                    );
-
-                    $html .= '
+			$qsg_where['QSG_deleted'] = false;
+			$query_params = apply_filters(
+				'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
+				array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
+			);
+			$QSGs = EEM_Question_Group::instance()->get_all($query_params);
+			$EQGs = ! empty($event_id)
+				? $this->_event->get_many_related(
+					'Question_Group',
+					[['Event_Question_Group.EQG_additional' => true]]
+				)
+				: [];
+			$EQGids = array_keys($EQGs);
+
+			if (! empty($QSGs)) {
+				$html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
+				foreach ($QSGs as $QSG) {
+					$checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
+					$edit_link = EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_question_group',
+							'QSG_ID' => $QSG->ID(),
+						),
+						EE_FORMS_ADMIN_URL
+					);
+
+					$html .= '
 					<p id="event-question-group-' . $QSG->ID() . '">
 						<input value="' . $QSG->ID() . '"'
-                             . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
+							 . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
 						<a href="' . $edit_link . '" title="'
-                             . sprintf(
-                                 esc_attr__('Edit %s Group', 'event_espresso'),
-                                 $QSG->get('QSG_name')
-                             )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+							 . sprintf(
+								 esc_attr__('Edit %s Group', 'event_espresso'),
+								 $QSG->get('QSG_name')
+							 )
+							 . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
 					</p>';
-                    if ($QSG->ID() === 2) {
-                        $html .= '
+					if ($QSG->ID() === 2) {
+						$html .= '
 					<p id="question-group-requirements-notice-pg" class="important-notice small-text" style="display: none;">'
-                                 . esc_html__(
-                                     'The Personal Information question group is required whenever the Address Information question group is activated.',
-                                     'event_espresso'
-                                 )
-                                 . '</p>';
-                    }
-                }
-                $html .= count($QSGs) > 10 ? '</div>' : '';
-
-                echo $html;
-            } else {
-                esc_html_e(
-                    'There seems to be a problem with your questions. Please contact support@eventespresso.com',
-                    'event_espresso'
-                );
-            }
-            do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
-            ?>
+								 . esc_html__(
+									 'The Personal Information question group is required whenever the Address Information question group is activated.',
+									 'event_espresso'
+								 )
+								 . '</p>';
+					}
+				}
+				$html .= count($QSGs) > 10 ? '</div>' : '';
+
+				echo $html;
+			} else {
+				esc_html_e(
+					'There seems to be a problem with your questions. Please contact support@eventespresso.com',
+					'event_espresso'
+				);
+			}
+			do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
+			?>
         </div>
         <?php
-    }
-
-
-    public function additional_question_group_update($evtobj, $data)
-    {
-        $question_groups = ! empty($data['add_attendee_question_groups'])
-            ? (array) $data['add_attendee_question_groups']
-            : [];
-        $added_qgs = array_keys($question_groups);
-        $success = [];
-
-        // let's get all current question groups associated with this event.
-        $current_qgs = $evtobj->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_additional' => true]]
-        );
-        $current_qgs = array_keys($current_qgs); // we just want the ids
-
-        // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $qgid) {
-                // add to event
-                if ($qgid) {
-                    $qg = $evtobj->add_question_group($qgid, false);
-                }
-                $success[] = ! empty($qg) ? 1 : 0;
-            }
-        }
-
-        // wait a minute... are there question groups missing in the saved groups that ARE with the current event?
-        $removed_qgs = array_diff($current_qgs, $added_qgs);
-
-        foreach ($removed_qgs as $qgid) {
-            $qg = $evtobj->remove_question_group($qgid, false);
-            $success[] = ! empty($qg) ? 1 : 0;
-        }
-
-
-        return in_array(0, $success, true) ? false : true;
-    }
+	}
+
+
+	public function additional_question_group_update($evtobj, $data)
+	{
+		$question_groups = ! empty($data['add_attendee_question_groups'])
+			? (array) $data['add_attendee_question_groups']
+			: [];
+		$added_qgs = array_keys($question_groups);
+		$success = [];
+
+		// let's get all current question groups associated with this event.
+		$current_qgs = $evtobj->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_additional' => true]]
+		);
+		$current_qgs = array_keys($current_qgs); // we just want the ids
+
+		// now let's get the groups selected in the editor and update (IF we have data)
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $qgid) {
+				// add to event
+				if ($qgid) {
+					$qg = $evtobj->add_question_group($qgid, false);
+				}
+				$success[] = ! empty($qg) ? 1 : 0;
+			}
+		}
+
+		// wait a minute... are there question groups missing in the saved groups that ARE with the current event?
+		$removed_qgs = array_diff($current_qgs, $added_qgs);
+
+		foreach ($removed_qgs as $qgid) {
+			$qg = $evtobj->remove_question_group($qgid, false);
+			$success[] = ! empty($qg) ? 1 : 0;
+		}
+
+
+		return in_array(0, $success, true) ? false : true;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -134,7 +134,7 @@ 
                 : [];
             $EQGids = array_keys($EQGs);
 
-            if (! empty($QSGs)) {
+            if ( ! empty($QSGs)) {
                 $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
                 foreach ($QSGs as $QSG) {
                     $checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
@@ -147,15 +147,15 @@ 
                     );
 
                     $html .= '
-					<p id="event-question-group-' . $QSG->ID() . '">
-						<input value="' . $QSG->ID() . '"'
-                             . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
-						<a href="' . $edit_link . '" title="'
+					<p id="event-question-group-' . $QSG->ID().'">
+						<input value="' . $QSG->ID().'"'
+                             . ' type="checkbox" name="add_attendee_question_groups['.$QSG->ID().']"'.$checked.' />
+						<a href="' . $edit_link.'" title="'
                              . sprintf(
                                  esc_attr__('Edit %s Group', 'event_espresso'),
                                  $QSG->get('QSG_name')
                              )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+                             . '" target="_blank">'.$QSG->get('QSG_name').'</a>
 					</p>';
                     if ($QSG->ID() === 2) {
                         $html .= '
@@ -199,7 +199,7 @@ 
         $current_qgs = array_keys($current_qgs); // we just want the ids
 
         // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $qgid) {
                 // add to event
                 if ($qgid) {

core/db_classes/EE_Event.class.php

Spacing +10 added lines, -10 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function getAvailableSpacesCalculator()
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -213,7 +213,7 @@ 
      */
     public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
     {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -236,7 +236,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return array();
         }
         $datetime_ids = array();
@@ -429,7 +429,7 @@ 
     public function short_description($num_words = 55, $more = null, $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -883,7 +883,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -972,7 +972,7 @@ 
      */
     public function is_sold_out($actual = false)
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1017,11 +1017,11 @@ 
     public function get_active_status($reset = false)
     {
         // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = array(array('EVT_ID' => $this->ID()));
@@ -1106,7 +1106,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();
@@ -1290,7 +1290,7 @@ 
             ]
         );
         $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext( ! $for_primary);
         if ($existing_relation->get($other_field) === false) {
             // Delete it. It's now no longer for primary or additional question groups.
             return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');

Indentation +1384 added lines, -1384 removed lines

@@ -15,1388 +15,1388 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all tickets
-        $tickets = $this->tickets(
-            array(
-                'default_where_conditions' => 'none',
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                EE_Datetime::active,
-                $where_params_for_event
-            ) > 0) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::upcoming,
-                    $where_params_for_event
-                ) > 0) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::expired,
-                        $where_params_for_event
-                    ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the row already exists, it will be updated. If it doesn't, it will be inserted.
-        // That's in EE_HABTM_Relation::add_relation_to().
-        return $this->_add_relation_to(
-            $question_group_id_or_obj,
-            'Question_Group',
-            [
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
-            ]
-        );
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the question group is used for the other type (primary or additional)
-        // then just update it. If not, delete it outright.
-        $existing_relation = $this->get_first_related(
-            'Event_Question_Group',
-            [
-                [
-                    'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
-                ]
-            ]
-        );
-        $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
-        if ($existing_relation->get($other_field) === false) {
-            // Delete it. It's now no longer for primary or additional question groups.
-            return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
-        }
-        // Just update it. They'll still use this question group for the other category
-        $existing_relation->save(
-            [
-                $field_to_update => false
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all tickets
+		$tickets = $this->tickets(
+			array(
+				'default_where_conditions' => 'none',
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (EEM_Datetime::instance()->get_datetime_count_for_status(
+				EE_Datetime::active,
+				$where_params_for_event
+			) > 0) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::upcoming,
+					$where_params_for_event
+				) > 0) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::expired,
+						$where_params_for_event
+					) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the row already exists, it will be updated. If it doesn't, it will be inserted.
+		// That's in EE_HABTM_Relation::add_relation_to().
+		return $this->_add_relation_to(
+			$question_group_id_or_obj,
+			'Question_Group',
+			[
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
+			]
+		);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the question group is used for the other type (primary or additional)
+		// then just update it. If not, delete it outright.
+		$existing_relation = $this->get_first_related(
+			'Event_Question_Group',
+			[
+				[
+					'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
+				]
+			]
+		);
+		$field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
+		$other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+		if ($existing_relation->get($other_field) === false) {
+			// Delete it. It's now no longer for primary or additional question groups.
+			return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
+		}
+		// Just update it. They'll still use this question group for the other category
+		$existing_relation->save(
+			[
+				$field_to_update => false
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

core/domain/services/registration/CopyRegistrationService.php

Indentation +141 added lines, -141 removed lines

@@ -27,151 +27,151 @@
 {
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event = $target_registration->event();
-        $field_name = 'Event_Question_Group.'
-            . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                $registration_to_copy->is_primary_registrant()
-            );
-        $question_groups = $new_event->question_groups([
-                [
-                    'Event.EVT_ID' => $new_event->ID(),
-                    $field_name => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]);
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event = $target_registration->event();
+		$field_name = 'Event_Question_Group.'
+			. EEM_Event_Question_Group::instance()->fieldNameForContext(
+				$registration_to_copy->is_primary_registrant()
+			);
+		$question_groups = $new_event->question_groups([
+				[
+					'Event.EVT_ID' => $new_event->ID(),
+					$field_name => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
 
 
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if (! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if (! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $save = false;
-        $previous_registration_payments = $registration_to_copy->registration_payments();
-        $new_registration_payment_total = 0;
-        $registration_to_copy_total = $registration_to_copy->paid();
-        foreach ($previous_registration_payments as $previous_registration_payment) {
-            if ($previous_registration_payment instanceof EE_Registration_Payment
-                && $previous_registration_payment->payment() instanceof EE_Payment
-                && $previous_registration_payment->payment()->is_approved()
-            ) {
-                $payment_amount = $previous_registration_payment->amount();
-                $new_registration_payment = EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_registration_payment->payment()->ID(),
-                        'RPY_amount' => $payment_amount,
-                    )
-                );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_registration_payment->set_amount(0);
-                $previous_registration_payment->save();
-                // now  increment/decrement payment amounts
-                $new_registration_payment_total += $payment_amount;
-                $registration_to_copy_total -= $payment_amount;
-                $save = true;
-            }
-        }
-        if ($save) {
-            $target_registration->set_paid($new_registration_payment_total);
-            $target_registration->save();
-            $registration_to_copy->set_paid($registration_to_copy_total);
-            $registration_to_copy->save();
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$save = false;
+		$previous_registration_payments = $registration_to_copy->registration_payments();
+		$new_registration_payment_total = 0;
+		$registration_to_copy_total = $registration_to_copy->paid();
+		foreach ($previous_registration_payments as $previous_registration_payment) {
+			if ($previous_registration_payment instanceof EE_Registration_Payment
+				&& $previous_registration_payment->payment() instanceof EE_Payment
+				&& $previous_registration_payment->payment()->is_approved()
+			) {
+				$payment_amount = $previous_registration_payment->amount();
+				$new_registration_payment = EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_registration_payment->payment()->ID(),
+						'RPY_amount' => $payment_amount,
+					)
+				);
+				if (! $new_registration_payment instanceof EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_registration_payment->set_amount(0);
+				$previous_registration_payment->save();
+				// now  increment/decrement payment amounts
+				$new_registration_payment_total += $payment_amount;
+				$registration_to_copy_total -= $payment_amount;
+				$save = true;
+			}
+		}
+		if ($save) {
+			$target_registration->set_paid($new_registration_payment_total);
+			$target_registration->save();
+			$registration_to_copy->set_paid($registration_to_copy_total);
+			$registration_to_copy->save();
+		}
+		return true;
+	}
 }