eventespresso / event-espresso-core

core/db_models/relations/EE_Belongs_To_Any_Relation.php

Indentation +73 added lines, -73 removed lines

@@ -18,83 +18,83 @@
 {
 
 
-    /**
-     * get_join_statement
-     *
-     * @param string $model_relation_chain
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        //create the sql string like
-        $this_table_fk_field = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        //ALSO, need to get the field with the model name
-        $field_with_model_name = $this->get_this_model()->get_field_containing_related_model_name();
+	/**
+	 * get_join_statement
+	 *
+	 * @param string $model_relation_chain
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		//create the sql string like
+		$this_table_fk_field = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		//ALSO, need to get the field with the model name
+		$field_with_model_name = $this->get_this_model()->get_field_containing_related_model_name();
 
 
-        $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
-        $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_fk_field->get_table_alias();
-        $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);
-        return $this->_left_join($other_table,
-                $other_table_alias,
-                $other_table_pk_field->get_table_column(),
-                $this_table_alias,
-                $this_table_fk_field->get_table_column(),
-                $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'")
-               . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-    }
+		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
+		$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_fk_field->get_table_alias();
+		$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);
+		return $this->_left_join($other_table,
+				$other_table_alias,
+				$other_table_pk_field->get_table_column(),
+				$this_table_alias,
+				$this_table_fk_field->get_table_column(),
+				$field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'")
+			   . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+	}
 
 
-    /**
-     * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @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
-     * @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);
-        //find the field on THIS model which a foreign key to the other model
-        $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        //set that field on the other model to this model's ID
-        $this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
-        //and make sure this model's field with the foreign model name is set to the correct value
-        $this_model_obj->set($this->get_this_model()->get_field_containing_related_model_name()->get_name(),
-            $this->get_other_model()->get_this_model_name());
-        $this_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @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
+	 * @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);
+		//find the field on THIS model which a foreign key to the other model
+		$fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		//set that field on the other model to this model's ID
+		$this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
+		//and make sure this model's field with the foreign model name is set to the correct value
+		$this_model_obj->set($this->get_this_model()->get_field_containing_related_model_name()->get_name(),
+			$this->get_other_model()->get_this_model_name());
+		$this_model_obj->save();
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the this model object's foreign key to its default, instead of pointing to the other model object
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @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);
-        //find the field on the other model which is a foreign key to this model
-        $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        //set that field on the other model to this model's ID
-        $this_model_obj->set($fk_on_this_model->get_name(), null, true);
-        $this_model_obj->set($this->get_this_model()->get_field_containing_related_model_name()->get_name(), null,
-            true);
-        $this_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the this model object's foreign key to its default, instead of pointing to the other model object
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @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);
+		//find the field on the other model which is a foreign key to this model
+		$fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		//set that field on the other model to this model's ID
+		$this_model_obj->set($fk_on_this_model->get_name(), null, true);
+		$this_model_obj->set($this->get_this_model()->get_field_containing_related_model_name()->get_name(), null,
+			true);
+		$this_model_obj->save();
+		return $other_model_obj;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once(EE_MODELS . 'relations/EE_Belongs_To_Relation.php');
+require_once(EE_MODELS.'relations/EE_Belongs_To_Relation.php');
 
 
 /**
@@ -35,16 +35,16 @@ 
 
         $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
         $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_fk_field->get_table_alias();
+                $this->get_this_model()->get_this_model_name()).$this_table_fk_field->get_table_alias();
         $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();
+                $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);
         return $this->_left_join($other_table,
                 $other_table_alias,
                 $other_table_pk_field->get_table_column(),
                 $this_table_alias,
                 $this_table_fk_field->get_table_column(),
-                $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'")
+                $field_with_model_name->get_qualified_column()."='".$this->get_other_model()->get_this_model_name()."'")
                . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 

core/db_models/relations/EE_HABTM_Relation.php

Indentation +199 added lines, -199 removed lines

@@ -12,203 +12,203 @@
  */
 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;
-
-    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);
-    }
-
-    /**
-     * 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();
-
-        $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;
-    }
-
-
-    /**
-     * 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;
-    }
-
-
-    /**
-     * 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());
-
-        $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($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;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
-
-        $query_params = array($cols_n_values);
-
-
-        $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
-        //if there is already an entry in the join table, indicating a relationship, we're done
-        //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($cols_n_values);
-        }
-        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());
-
-        $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);
-        }
-
-        $this->get_join_model()->delete(array($cols_n_values));
-        return $other_model_obj;
-    }
+	/**
+	 * 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;
+
+
+	/**
+	 * 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 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);
+
+		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);
+
+		$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());
+
+		$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($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;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
+
+		$query_params = array($cols_n_values);
+
+
+		$existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
+		//if there is already an entry in the join table, indicating a relationship, we're done
+		//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($cols_n_values);
+		}
+		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());
+
+		$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);
+		}
+
+		$this->get_join_model()->delete(array($cols_n_values));
+		return $other_model_obj;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-require_once(EE_MODELS . 'relations/EE_Model_Relation_Base.php');
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
 
 
 /**
@@ -68,18 +68,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->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();
+                $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);
+                $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
         return $SQL;
     }
@@ -104,16 +104,16 @@ 
         }
         $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();
+                $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();
+                $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);
+                $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;
     }
 
@@ -146,12 +146,12 @@ 
         );
 
         //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;
             }
@@ -165,7 +165,7 @@ 
         //if there is already an entry in the join table, indicating a relationship, we're done
         //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($cols_n_values);
         }
         return $other_model_obj;
@@ -196,12 +196,12 @@ 
         );
 
         //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;
             }

core/db_models/relations/EE_Belongs_To_Relation.php

Indentation +113 added lines, -113 removed lines

@@ -13,128 +13,128 @@
 class EE_Belongs_To_Relation extends EE_Model_Relation_Base
 {
 
-    /**
-     * Object representing the relationship between two models. Belongs_To means that THIS model has the foreign key
-     * to the other model. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                                For Belongs_To relations, this is set to FALSE by
-     *                                                              default. if there are related models across this
-     *                                                              relation, block (prevent and add an error) the
-     *                                                              deletion of this model
-     * @param string  $related_model_objects_deletion_error_message a customized error message on blocking deletes
-     *                                                              instead of the default
-     */
-    public function __construct($block_deletes = false, $related_model_objects_deletion_error_message = null)
-    {
-        parent::__construct($block_deletes, $related_model_objects_deletion_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Belongs_To means that THIS model has the foreign key
+	 * to the other model. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                                For Belongs_To relations, this is set to FALSE by
+	 *                                                              default. if there are related models across this
+	 *                                                              relation, block (prevent and add an error) the
+	 *                                                              deletion of this model
+	 * @param string  $related_model_objects_deletion_error_message a customized error message on blocking deletes
+	 *                                                              instead of the default
+	 */
+	public function __construct($block_deletes = false, $related_model_objects_deletion_error_message = null)
+	{
+		parent::__construct($block_deletes, $related_model_objects_deletion_error_message);
+	}
 
 
-    /**
-     * get_join_statement
-     *
-     * @param string $model_relation_chain
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        //create the sql string like
-        $this_table_fk_field  = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
-        $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_fk_field->get_table_alias();
-        $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);
-        return $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
-                $this_table_alias,
-                $this_table_fk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-    }
+	/**
+	 * get_join_statement
+	 *
+	 * @param string $model_relation_chain
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		//create the sql string like
+		$this_table_fk_field  = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
+		$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_fk_field->get_table_alias();
+		$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);
+		return $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
+				$this_table_alias,
+				$this_table_fk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+	}
 
 
-    /**
-     * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @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
-     * @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);
-        //find the field on the other model which is a foreign key to this model
-        $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        if ($this_model_obj->get($fk_on_this_model->get_name()) != $other_model_obj->ID()) {
-            //set that field on the other model to this model's ID
-            $this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
-            $this_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+	/**
+	 * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @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
+	 * @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);
+		//find the field on the other model which is a foreign key to this model
+		$fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		if ($this_model_obj->get($fk_on_this_model->get_name()) != $other_model_obj->ID()) {
+			//set that field on the other model to this model's ID
+			$this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
+			$this_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the this model object's foreign key to its default, instead of pointing to the other model object
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @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);
-        //find the field on the other model which is a foreign key to this model
-        $fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        //set that field on the other model to this model's ID
-        $this_model_obj->set($fk_on_this_model->get_name(), null, true);
-        $this_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the this model object's foreign key to its default, instead of pointing to the other model object
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @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);
+		//find the field on the other model which is a foreign key to this model
+		$fk_on_this_model = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		//set that field on the other model to this model's ID
+		$this_model_obj->set($fk_on_this_model->get_name(), null, true);
+		$this_model_obj->save();
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Overrides parent so that we don't NEED to save the $model_object before getting the related objects.
-     *
-     * @param EE_Base_Class $model_obj_or_id
-     * @param array         $query_params                            like EEM_Base::get_all's $query_params
-     * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_obj_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong('EE_Model_Relation_Base::get_all_related',
-                __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1');
-        }
-        //get column on this model object which is a foreign key to the other model
-        $fk_field_obj = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        //get its value
-        if ($model_obj_or_id instanceof EE_Base_Class) {
-            $model_obj = $model_obj_or_id;
-        } else {
-            $model_obj = $this->get_this_model()->ensure_is_obj($model_obj_or_id);
-        }
-        $ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
-        //get all where their PK matches that value
-        $query_params[0][$this->get_other_model()->get_primary_key_field()->get_name()] = $ID_value_on_other_model;
-        $query_params                                                                   = $this->_disable_default_where_conditions_on_query_param($query_params);
+	/**
+	 * Overrides parent so that we don't NEED to save the $model_object before getting the related objects.
+	 *
+	 * @param EE_Base_Class $model_obj_or_id
+	 * @param array         $query_params                            like EEM_Base::get_all's $query_params
+	 * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_obj_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong('EE_Model_Relation_Base::get_all_related',
+				__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1');
+		}
+		//get column on this model object which is a foreign key to the other model
+		$fk_field_obj = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		//get its value
+		if ($model_obj_or_id instanceof EE_Base_Class) {
+			$model_obj = $model_obj_or_id;
+		} else {
+			$model_obj = $this->get_this_model()->ensure_is_obj($model_obj_or_id);
+		}
+		$ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
+		//get all where their PK matches that value
+		$query_params[0][$this->get_other_model()->get_primary_key_field()->get_name()] = $ID_value_on_other_model;
+		$query_params                                                                   = $this->_disable_default_where_conditions_on_query_param($query_params);
 //		echo '$query_params';
 //		var_dump($query_params);
-        return $this->get_other_model()->get_all($query_params);
-    }
+		return $this->get_other_model()->get_all($query_params);
+	}
 
 }

Spacing +4 added lines, -4 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once(EE_MODELS . 'relations/EE_Model_Relation_Base.php');
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
 
 /**
  * Class EE_Belongs_To_Relation
@@ -44,13 +44,13 @@ 
         $this_table_fk_field  = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
         $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
         $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_fk_field->get_table_alias();
+                $this->get_this_model()->get_this_model_name()).$this_table_fk_field->get_table_alias();
         $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();
+                $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);
         return $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
                 $this_table_alias,
-                $this_table_fk_field->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+                $this_table_fk_field->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 
 

core/EE_Data_Migration_Manager.core.php

Indentation +25 added lines, -25 removed lines

@@ -127,9 +127,9 @@ 
 	protected $_table_analysis;
 
 	/**
-     * 	@var EE_Data_Migration_Manager $_instance
+	 * 	@var EE_Data_Migration_Manager $_instance
 	 * 	@access 	private
-     */
+	 */
 	private static $_instance = NULL;
 
 
@@ -720,18 +720,18 @@ 
 
 
 
-    /**
-     * 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 \EE_Error
-     */
+	/**
+	 * 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 \EE_Error
+	 */
 	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 $folder_path){
-                $folder_path = EEH_File::end_with_directory_separator($folder_path);
+				$folder_path = EEH_File::end_with_directory_separator($folder_path);
 				$files = glob( $folder_path. '*.dms.php' );
 
 				if ( empty( $files ) ) {
@@ -748,15 +748,15 @@ 
 					if( $slug !== 'Core' ){
 						if( ! EE_Registry::instance()->get_addon_by_name( $slug ) ) {
 							EE_Error::doing_it_wrong(
-							    __FUNCTION__,
-                                sprintf(
-                                    __( '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'
-                            );
+								__FUNCTION__,
+								sprintf(
+									__( '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;
@@ -939,12 +939,12 @@ 
 	}
 
 /**
-	 * Resets the borked data migration scripts so they're no longer borked
-	 * so we can again attempt to migrate
-	 *
-	 * @return bool
-	 * @throws \EE_Error
-	 */
+ * 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)

Spacing +206 added lines, -206 removed lines

@@ -24,7 +24,7 @@ 
  * to indicate it successfully migrate some data, and has nothing left to do; or EE_Data_Migration_Manager::status_fatal_error to indicate
  * an error occurred which means the ajax script should probably stop executing.
  */
-class EE_Data_Migration_Manager{
+class EE_Data_Migration_Manager {
 
 	/**
 	 *
@@ -81,7 +81,7 @@ 
 	 * 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;
+	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
@@ -141,7 +141,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;
@@ -151,7 +151,7 @@ 
 	 * all new usages of the singleton should be made with Classname::instance()) and returns it
 	 * @return EE_Data_Migration_Manager
 	 */
-	public static function reset(){
+	public static function reset() {
 		self::$_instance = NULL;
 		return self::instance();
 	}
@@ -161,7 +161,7 @@ 
 	/**
 	 * constructor
 	 */
-	private function __construct(){
+	private function __construct() {
 		$this->stati_that_indicate_to_continue_migrations = array(
 			self::status_continue,
 			self::status_completed
@@ -180,13 +180,13 @@ 
 		);
 		//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 );
+		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);
 	}
 
 
@@ -199,21 +199,21 @@ 
 	 * @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){
+	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);
+		$parts = explode(".", $plugin_slug_and_version_string);
 
-		if(count($parts) == 4){
+		if (count($parts) == 4) {
 			//it's 4.2-style.eg Core.4.1.0
-			$plugin_slug = $parts[0];//eg Core
+			$plugin_slug = $parts[0]; //eg Core
 			$version_string = $parts[1].".".$parts[2].".".$parts[3]; //eg 4.1.0
-		}else{
+		} 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);
+		return array($plugin_slug, $version_string);
 	}
 
 	/**
@@ -224,21 +224,21 @@ 
 	 * @return EE_Data_Migration_Script_Base
 	 * @throws EE_Error
 	 */
-	private function _get_dms_class_from_wp_option($dms_option_name,$dms_option_value){
+	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'])){
+		if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
 			$class = new $data_migration_data['class'];
-			if($class instanceof EE_Data_Migration_Script_Base){
+			if ($class instanceof EE_Data_Migration_Script_Base) {
 				$class->instantiate_from_array_of_properties($data_migration_data);
 				return $class;
-			}else{
+			} 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']));
+				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{
+		} 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));
+			throw new EE_Error(sprintf(__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name));
 		}
 	}
 	/**
@@ -246,34 +246,34 @@ 
 	 * 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 ){
+	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_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']);
+			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']);
+				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()){
+					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){
+				} 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) ){
+			 if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
 				$this->_data_migrations_ran = array();
 			}
 		}
@@ -290,7 +290,7 @@ 
 	 * @param        $new_table
 	 * @return mixed string or int
 	 */
-	public function get_mapping_new_pk( $script_name, $old_table, $old_pk, $new_table){
+	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;
@@ -301,9 +301,9 @@ 
 	 * option returned in this array is the most-recently ran DMS option
 	 * @return array
 	 */
-	 public function get_all_migration_script_options(){
+	 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);
+		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);
 	}
 
 	/**
@@ -311,8 +311,8 @@ 
 	 * @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(EE_CORE.'data_migration_scripts') );
+	public function get_data_migration_script_folders() {
+		return  apply_filters('FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', array(EE_CORE.'data_migration_scripts'));
 	}
 
 	/**
@@ -324,11 +324,11 @@ 
 	 * }
 	 * @throws EE_Error
 	 */
-	public function script_migrates_to_version($migration_script_name){
+	public function script_migrates_to_version($migration_script_name) {
 		$dms_info = $this->parse_dms_classname($migration_script_name);
 		return array(
-			'slug'=> $dms_info[ 'slug' ],
-			'version'=> $dms_info[ 'major_version' ] . "." . $dms_info[ 'minor_version' ] . "." . $dms_info[ 'micro_version' ] );
+			'slug'=> $dms_info['slug'],
+			'version'=> $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'] );
 	}
 
 	/**
@@ -337,13 +337,13 @@ 
 	 * @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){
+	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));
+		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]));
+		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
@@ -352,33 +352,33 @@ 
 	 * 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() );
+	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 ){
+		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)){
+			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
 //				echo "4.1.0 is greater than $previous_version_installed! update the option";
 				$db_state = array('Core'=>$previous_version_installed);
-			}else{
+			} else {
 //					echo "4.1.0 is SMALLER than $previous_version_installed";
 					$db_state = array('Core'=>EVENT_ESPRESSO_VERSION);
 			}
-			update_option(EE_Data_Migration_Manager::current_database_state,$db_state);
+			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)){
+		if ( ! is_array($db_state)) {
 			$db_state = array('Core'=>$db_state);
-			update_option(EE_Data_Migration_Manager::current_database_state,$db_state);
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
 		}
 		return $db_state;
 	}
@@ -389,7 +389,7 @@ 
 	 * or they don't apply), returns an empty array
 	 * @return EE_Data_Migration_Script_Base[]
 	 */
-	public function check_for_applicable_data_migration_scripts(){
+	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));
@@ -402,62 +402,62 @@ 
 		$iteration = 0;
 		$next_database_state_to_consider = $current_database_state;
 		$theoretical_database_state = NULL;
-		do{
+		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){
+			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' ];
+				$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 ||
+				if ( ! $scripts_ran ||
 						! isset($scripts_ran[$script_converts_plugin_slug]) ||
-						! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])){
+						! 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 = new $classname( $this->_get_table_manager(), $this->_get_table_analysis() );
+					$script = new $classname($this->_get_table_manager(), $this->_get_table_analysis());
 					/* @var $script EE_Data_Migration_Script_Base */
 					$can_migrate = $script->can_migrate_from_version($theoretical_database_state);
-					if($can_migrate){
+					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' ];
+						$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];
-					if( $script->get_status() != self::status_completed){
+					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' ];
+						$next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version'];
 						unset($script_class_and_filepaths_available[$classname]);
-					}else{
+					} else {
 						//it must have a status that indicates it has finished, so we don't want to try and run it again
 					}
-				}else{
+				} 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);
+		}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){
+		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){
+			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 );
+		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;
 	}
 
@@ -471,14 +471,14 @@ 
 	 * @param bool $include_completed_scripts
 	 * @return EE_Data_Migration_Script_Base
 	 */
-	public function get_last_ran_script($include_completed_scripts = false){
+	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){
+		if ($include_completed_scripts) {
 			return $this->_last_ran_script;
-		}else{
+		} else {
 			return $this->_last_ran_incomplete_script;
 		}
 	}
@@ -501,19 +501,19 @@ 
 	 * 		@type string $message string describing what was done during this step
 	 * }
 	 */
-	public function migration_step( $step_size = 0 ){
+	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 );
+		if (class_exists('EE_CPT_Strategy')) {
+			remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5);
 		}
 
-		try{
+		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
@@ -534,18 +534,18 @@ 
 				//and add to the array/wp option showing the scripts ran
 //				$this->_data_migrations_ran[$this->script_migrates_to_version(get_class($currently_executing_script))] = $currently_executing_script;
 				$migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
-				$plugin_slug = $migrates_to[ 'slug' ];
-				$version = $migrates_to[ 'version' ];
+				$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){
+		} 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() );
+			$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));
+			$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,
@@ -555,16 +555,16 @@ 
 			);
 		}
 		//ok so we definitely have a data migration script
-		try{
+		try {
 			//how big of a bite do we want to take? Allow users to easily override via their wp-config
-			if( ! absint( $step_size ) > 0 ){
-				$step_size = defined( 'EE_MIGRATION_STEP_SIZE' ) && absint( EE_MIGRATION_STEP_SIZE ) ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size;
+			if ( ! absint($step_size) > 0) {
+				$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()){
+			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(),
@@ -576,16 +576,16 @@ 
 				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(
+					$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())
+							'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 ){
+					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!
@@ -599,39 +599,39 @@ 
 						'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())),
+						'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){
+		} 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){
+			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{
+			} 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()),
+				'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){
+		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));
+			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 ) {
+		if ($init_dbs) {
 			$this->initialize_db_for_enqueued_ee_plugins();
 		}
 		return $response_array;
@@ -649,23 +649,23 @@ 
 	 * '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(){
+	public function response_to_migration_ajax_request() {
 //		//start output buffer just to make sure we don't mess up the json
 		ob_start();
-		try{
+		try {
 			$response = $this->migration_step();
-		}catch(Exception $e){
+		} 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()),
+				'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;
+		$response['message'] .= $warnings_etc;
 		return $response;
 	}
 
@@ -678,14 +678,14 @@ 
 	 * }
 	 * @return void
 	 */
-	public function update_current_database_state_to($slug_and_version = null){
-		if( ! $slug_and_version ){
+	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);
+		$current_database_state[$slug_and_version['slug']] = $slug_and_version['version'];
+		update_option(self::current_database_state, $current_database_state);
 	}
 
 	/**
@@ -696,20 +696,20 @@ 
 	 * }
 	 * @return boolean
 	 */
-	public function database_needs_updating_to( $slug_and_version ) {
+	public function database_needs_updating_to($slug_and_version) {
 
-		$slug = $slug_and_version[ 'slug' ];
-		$version = $slug_and_version[ '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 ] ) ) {
+		if ( ! isset($current_database_state[$slug])) {
 			return true;
-		}else{
+		} 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 );
+			$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 ] ) {
+			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;
 				}
@@ -727,33 +727,33 @@ 
      * @return array keys are expected classnames, values are their filepaths
      * @throws \EE_Error
      */
-	public function get_all_data_migration_scripts_available(){
-		if( ! $this->_data_migration_class_to_filepath_map){
+	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 $folder_path){
+			foreach ($this->get_data_migration_script_folders() as $folder_path) {
                 $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 ) ) {
+				if (empty($files)) {
 					continue;
 				}
 
-				foreach($files as $file){
-					$pos_of_last_slash = strrpos($file,DS);
+				foreach ($files as $file) {
+					$pos_of_last_slash = strrpos($file, DS);
 					$classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
-					$migrates_to = $this->script_migrates_to_version( $classname );
-					$slug = $migrates_to[ 'slug' ];
+					$migrates_to = $this->script_migrates_to_version($classname);
+					$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' ){
-						if( ! EE_Registry::instance()->get_addon_by_name( $slug ) ) {
+					if ($slug !== 'Core') {
+						if ( ! EE_Registry::instance()->get_addon_by_name($slug)) {
 							EE_Error::doing_it_wrong(
 							    __FUNCTION__,
                                 sprintf(
-                                    __( 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', 'event_espresso' ),
+                                    __('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() ) )
+                                    implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
                                 ),
                                 '4.3.0.alpha.019'
                             );
@@ -776,7 +776,7 @@ 
 	 * from each addon, and check if they need updating,
 	 * @return boolean
 	 */
-	public function addons_need_updating(){
+	public function addons_need_updating() {
 		return false;
 	}
 	/**
@@ -785,25 +785,25 @@ 
 	 * @param string $error_message
 	 * @throws EE_Error
 	 */
-	public function add_error_to_migrations_ran($error_message){
+	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_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;
+		$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){
+		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{
+		} 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();
@@ -813,39 +813,39 @@ 
 			$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,$last_ran_migration_script_properties);
+		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){
+	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){
+		foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
+			foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
 	//			echo "saving migration script to $version_string<br>";
 				$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){
+				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);
+					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
+				} else {//we don't know what this array-thing is. So just save it as-is
 	//				$array_of_migrations[$version_string] = $array_or_migration_obj;
-					if($old_option_value != $array_or_migration_obj){
-						$successful_updates = update_option($option_name,$array_or_migration_obj);
+					if ($old_option_value != $array_or_migration_obj) {
+						$successful_updates = update_option($option_name, $array_or_migration_obj);
 					}
 				}
-				if( ! $successful_updates ){
+				if ( ! $successful_updates) {
 					global $wpdb;
 					return $wpdb->last_error;
 				}
@@ -869,17 +869,17 @@ 
 	 * @return EE_Data_Migration_Script_Base
 	 * @throws EE_Error
 	 */
-	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)));
+	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));
+		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)));
+		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;
@@ -891,25 +891,25 @@ 
 	 * @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'){
+	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){
+		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' ];
+				$this_plugin_slug = $migrates_to['slug'];
 //				$version_string = $migrates_to[ 'version' ];
 //				$details = $this->parse_dms_classname($classname);
-				if($this_plugin_slug == $plugin_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);
+			} 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' ], '<')){
+				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;
 				}
@@ -929,11 +929,11 @@ 
 	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
 	 * @return EE_Data_Migration_Script_Base
 	 */
-	public function get_migration_ran( $version, $plugin_slug = 'Core' ) {
+	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{
+		if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) {
+			return $migrations_ran[$plugin_slug][$version];
+		} else {
 			return NULL;
 		}
 	}
@@ -945,20 +945,20 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function reattempt(){
+	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 ($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 ) {
+		}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 ) ) );
+		} 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();
 	}
@@ -968,19 +968,19 @@ 
 	 * @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;
+	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 ) {
+	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 );
+		update_option(self::db_init_queue_option_name, $queue);
 	}
 	/**
 	 * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
@@ -990,26 +990,26 @@ 
 	public function initialize_db_for_enqueued_ee_plugins() {
 //		EEH_Debug_Tools::instance()->start_timer( '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 ) {
+		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 );
+			} 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' ){
+			if ($plugin_slug == 'Core') {
 				EE_System::instance()->initialize_db_if_no_migrations_required(
 						false,
 						$verify_db
 					);
-			}else{
+			} 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 ) {
+				foreach (EE_Registry::instance()->addons as $addon) {
+					if ($addon->name() == $plugin_slug) {
 
-						$addon->initialize_db_if_no_migrations_required( $verify_db );
+						$addon->initialize_db_if_no_migrations_required($verify_db);
 						break;
 					}
 				}
@@ -1019,7 +1019,7 @@ 
 //		EEH_Debug_Tools::instance()->show_times();
 		//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 );
+		delete_option(self::db_init_queue_option_name);
 	}
 
 	/**
@@ -1028,8 +1028,8 @@ 
 	 * '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() );
+	public function get_db_initialization_queue() {
+		return get_option(self::db_init_queue_option_name, array());
 	}
 
 	/**
@@ -1038,13 +1038,13 @@ 
 	 * @throws \EE_Error
 	 */
 	protected function _get_table_analysis() {
-		if( $this->_table_analysis instanceof TableAnalysis ) {
+		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 )
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
 				)
 			);
 		}
@@ -1056,13 +1056,13 @@ 
 	 * @throws \EE_Error
 	 */
 	protected function _get_table_manager() {
-		if( $this->_table_manager instanceof TableManager ) {
+		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 )
+					__('Table manager class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
 				)
 			);
 		}

Braces +21 added lines, -21 removed lines

@@ -208,7 +208,7 @@ 
 			//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{
+		} else{
 			//it's 4.1-style: eg 4.1.0
 			$plugin_slug = 'Core';
 			$version_string = $plugin_slug_and_version_string;//eg 4.1.0
@@ -231,12 +231,12 @@ 
 			if($class instanceof EE_Data_Migration_Script_Base){
 				$class->instantiate_from_array_of_properties($data_migration_data);
 				return $class;
-			}else{
+			} 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{
+		} 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));
 		}
@@ -266,7 +266,7 @@ 
 						//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){
+				} 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']);
 				}
@@ -367,7 +367,7 @@ 
 				//so we want the data migrations to happen. SO, we're going to say the DB is at that state
 //				echo "4.1.0 is greater than $previous_version_installed! update the option";
 				$db_state = array('Core'=>$previous_version_installed);
-			}else{
+			} else{
 //					echo "4.1.0 is SMALLER than $previous_version_installed";
 					$db_state = array('Core'=>EVENT_ESPRESSO_VERSION);
 			}
@@ -435,10 +435,10 @@ 
 						$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{
+					} else{
 						//it must have a status that indicates it has finished, so we don't want to try and run it again
 					}
-				}else{
+				} 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!
@@ -478,7 +478,7 @@ 
 		}
 		if($include_completed_scripts){
 			return $this->_last_ran_script;
-		}else{
+		} else{
 			return $this->_last_ran_incomplete_script;
 		}
 	}
@@ -539,7 +539,7 @@ 
 				$this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script;
 			}
 			$current_script_name = get_class($currently_executing_script);
-		}catch(Exception $e){
+		} 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() );
@@ -604,14 +604,14 @@ 
 					);
 					break;
 			}
-		}catch(Exception $e){
+		} 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{
+			} else{
 				$script_name = __("Error getting Migration Script", "event_espresso");
 			}
 			$response_array = array(
@@ -654,7 +654,7 @@ 
 		ob_start();
 		try{
 			$response = $this->migration_step();
-		}catch(Exception $e){
+		} catch(Exception $e){
 			$response = array(
 				'records_to_migrate'=>0,
 				'records_migrated'=>0,
@@ -703,7 +703,7 @@ 
 		$current_database_state = get_option(self::current_database_state);
 		if( ! isset( $current_database_state[ $slug ] ) ) {
 			return true;
-		}else{
+		} 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 );
@@ -803,7 +803,7 @@ 
 			//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{
+		} 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();
@@ -839,7 +839,7 @@ 
 					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
+				} else{//we don't know what this array-thing is. So just save it as-is
 	//				$array_of_migrations[$version_string] = $array_or_migration_obj;
 					if($old_option_value != $array_or_migration_obj){
 						$successful_updates = update_option($option_name,$array_or_migration_obj);
@@ -906,7 +906,7 @@ 
 				}
 				//if it wasn't for core, we must keep searching for one that is!
 				continue;
-			}else{
+			} 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' ], '<')){
@@ -933,7 +933,7 @@ 
 		$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{
+		} else{
 			return NULL;
 		}
 	}
@@ -955,9 +955,9 @@ 
 		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 ) {
+		} elseif( $last_ran_script instanceof EE_Data_Migration_Script_Base ) {
 			$last_ran_script->reattempt();
-		}else{
+		} 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();
@@ -995,7 +995,7 @@ 
 			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{
+			} 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 );
 			}
@@ -1004,7 +1004,7 @@ 
 						false,
 						$verify_db
 					);
-			}else{
+			} 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 ) {

core/db_models/fields/EE_Datetime_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -567,7 +567,7 @@ 
      * allowed)
      *
      * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
+     * @return  null|DbSafeDateTime null | DateTime
      * @throws \EE_Error
      */
     public function prepare_for_set_from_db($datetime_string)
@@ -724,7 +724,7 @@ 
      *
      * @param \DateTimeZone $DateTimeZone
      * @param int           $time
-     * @return mixed
+     * @return integer
      * @throws \DomainException
      */
     public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)

Spacing +10 added lines, -10 removed lines

@@ -210,8 +210,8 @@ 
 
             default :
                 return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
+                    ? $this->_pretty_date_format.' '.$this->_pretty_time_format
+                    : $this->_date_format.' '.$this->_time_format;
         }
     }
 
@@ -467,7 +467,7 @@ 
      */
     protected function _prepare_for_display($DateTime, $schema = false)
     {
-        if (! $DateTime instanceof DateTime) {
+        if ( ! $DateTime instanceof DateTime) {
             if ($this->_nullable) {
                 return '';
             } else {
@@ -502,15 +502,15 @@ 
             if ($this->_display_timezone()) {
                 //must be explicit because schema could equal true.
                 if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
+                    $timezone_string = ' ('.$DateTime->format('T').')';
                 } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+                    $timezone_string = ' <span class="ee_dtt_timezone_string">('.$DateTime->format('T').')</span>';
                 }
             } else {
                 $timezone_string = '';
             }
 
-            return $DateTime->format($format_string) . $timezone_string;
+            return $DateTime->format($format_string).$timezone_string;
         } else {
             return $DateTime->format($format_string);
         }
@@ -528,7 +528,7 @@ 
     public function prepare_for_use_in_db($datetime_value)
     {
         //we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+        if ( ! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
             throw new EE_Error(
                 __(
                     'The incoming value being prepared for setting in the database must either be empty or a php DateTime object',
@@ -583,7 +583,7 @@ 
             }
         }
 
-        if (! $DateTime instanceof DbSafeDateTime) {
+        if ( ! $DateTime instanceof DbSafeDateTime) {
             // if still no datetime object, then let's just use now
             $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
         }
@@ -662,7 +662,7 @@ 
         }
         //not a unix timestamp.  So we will use the set format on this object and set timezone to
         //create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
+        $format = $this->_date_format.' '.$this->_time_format;
         try {
             $DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
             if ($DateTime instanceof DateTime) {
@@ -671,7 +671,7 @@ 
                     $this->_DateTimeZone
                 );
             }
-            if (! $DateTime instanceof DbSafeDateTime) {
+            if ( ! $DateTime instanceof DbSafeDateTime) {
                 throw new EE_Error(
                     sprintf(
                         __('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),

Indentation +749 added lines, -749 removed lines

@@ -15,753 +15,753 @@
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-    /**
-     * @type string $_date_format
-     */
-    protected $_date_format = '';
-
-    /**
-     * @type string $_time_format
-     */
-    protected $_time_format = '';
-
-    /**
-     * @type string $_pretty_date_format
-     */
-    protected $_pretty_date_format = '';
-
-    /**
-     * @type string $_pretty_time_format
-     */
-    protected $_pretty_time_format = '';
-
-    /**
-     * @type DateTimeZone $_DateTimeZone
-     */
-    protected $_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_UTC_DateTimeZone
-     */
-    protected $_UTC_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_blog_DateTimeZone
-     */
-    protected $_blog_DateTimeZone;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var mixed (null|string)
-     */
-    protected $_date_time_output;
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
-     *
-     * @var string
-     */
-    protected $_timezone_string;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected $_blog_offset;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @param string $timezone_string
-     * @param string $date_format
-     * @param string $time_format
-     * @param string $pretty_date_format
-     * @param string $pretty_time_format
-     * @throws \EE_Error
-     */
-    public function __construct(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $timezone_string = '',
-        $date_format = '',
-        $time_format = '',
-        $pretty_date_format = '',
-        $pretty_time_format = ''
-    ) {
-
-        $this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
-        $this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
-        $this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
-        $this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaFormat('date-time');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_UTC_DateTimeZone()
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_blog_DateTimeZone()
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('');
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
-     *
-     * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
-     *                                                              timestamp
-     * @return DateTime
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output($pretty = false)
-    {
-
-        switch ($this->_date_time_output) {
-            case 'time' :
-                return $pretty ? $this->_pretty_time_format : $this->_time_format;
-                break;
-
-            case 'date' :
-                return $pretty ? $this->_pretty_date_format : $this->_date_format;
-                break;
-
-            default :
-                return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string $what acceptable values are 'time' or 'date'.
-     *                     Any other value will be set but will always result
-     *                     in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output($what = null)
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
-     * We also set some other properties in this method.
-     *
-     * @param string $timezone_string A valid timezone string as described by @link
-     *                                http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone_string)
-    {
-        if (empty($timezone_string) && $this->_timezone_string !== null) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string $timezone_string
-     * @return \DateTimeZone
-     * @throws \EE_Error
-     */
-    protected function _create_timezone_object_from_timezone_string($timezone_string = '')
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @access public
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = $format;
-        } else {
-            $this->_date_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_date_format : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @access public
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = $format;
-        } else {
-            $this->_time_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_time_format : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @access public
-     * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format($format)
-    {
-        $this->_pretty_date_format = $format;
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @access public
-     * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format($format)
-    {
-        $this->_pretty_time_format = $format;
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            );
-        } else {
-            //parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-
-        //make sure $current is in the correct timezone.
-        $current->setTimezone($this->_DateTimeZone);
-
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            );
-        } else {
-            //parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-
-        //make sure $current is in the correct timezone
-        $current->setTimezone($this->_DateTimeZone);
-
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
-     * datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param  DateTime $DateTime
-     * @return string formatted date time for given timezone
-     * @throws \EE_Error
-     */
-    public function prepare_for_get($DateTime)
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param mixed $DateTime
-     * @param null  $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, $schema = null)
-    {
-        return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime    $DateTime
-     * @param bool|string $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _prepare_for_display($DateTime, $schema = false)
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                } else {
-                    $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                }
-            }
-        }
-        $format_string = $this->_get_date_time_output($schema);
-        //make sure datetime_value is in the correct timezone (in case that's been updated).
-        $DateTime->setTimezone($this->_DateTimeZone);
-        if ($schema) {
-            if ($this->_display_timezone()) {
-                //must be explicit because schema could equal true.
-                if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
-                } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-                }
-            } else {
-                $timezone_string = '';
-            }
-
-            return $DateTime->format($format_string) . $timezone_string;
-        } else {
-            return $DateTime->format($format_string);
-        }
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param  mixed $datetime_value u
-     * @return string mysql timestamp in UTC
-     * @throws \EE_Error
-     */
-    public function prepare_for_use_in_db($datetime_value)
-    {
-        //we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            throw new EE_Error(
-                __(
-                    'The incoming value being prepared for setting in the database must either be empty or a php DateTime object',
-                    'event_espresso'
-                )
-            );
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if ( ! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-
-            return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
-     * @throws \EE_Error
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        //if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        if (empty($datetime_string)) {
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        } else {
-            $DateTime = DateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-            if ($DateTime instanceof \DateTime) {
-                $DateTime = new DbSafeDateTime(
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
-                    $this->get_UTC_DateTimeZone()
-                );
-            }
-        }
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        $DateTime->setTimezone($this->_DateTimeZone);
-
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws \EE_Error
-     */
-    protected function _display_timezone()
-    {
-
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
-     *                                                    in the format that is set on the date_field (or DateTime
-     *                                                    object)!
-     * @return DateTime
-     */
-    protected function _get_date_object($date_string)
-    {
-        //first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            $date_string->setTimezone($this->_DateTimeZone);
-
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        //not a unix timestamp.  So we will use the set format on this object and set timezone to
-        //create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if ($DateTime instanceof DateTime) {
-                $DateTime = new DbSafeDateTime(
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
-                    $this->_DateTimeZone
-                );
-            }
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        __('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @param bool          $first_only
-     * @return mixed
-     */
-    public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
-    {
-        $time = is_int($time) || $time === null ? $time : strtotime($time);
-        $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        $transitions = $DateTimeZone->getTransitions($time);
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
-    }
-
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @return mixed
-     * @throws \DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        $transitions = $this->get_timezone_transitions($DateTimeZone, $time);
-        if ( ! isset($transitions['offset'])) {
-            throw new DomainException();
-        }
-        return $transitions['offset'];
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param  string $timezone_string
-     * @return string           abbreviation
-     * @throws \EE_Error
-     */
-    public function get_timezone_abbrev($timezone_string)
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-
-        return $dateTime->format('T');
-    }
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        } else {
-            return parent::get_default_value();
-        }
-    }
-
-
-    public function getSchemaDescription()
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+	/**
+	 * @type string $_date_format
+	 */
+	protected $_date_format = '';
+
+	/**
+	 * @type string $_time_format
+	 */
+	protected $_time_format = '';
+
+	/**
+	 * @type string $_pretty_date_format
+	 */
+	protected $_pretty_date_format = '';
+
+	/**
+	 * @type string $_pretty_time_format
+	 */
+	protected $_pretty_time_format = '';
+
+	/**
+	 * @type DateTimeZone $_DateTimeZone
+	 */
+	protected $_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_UTC_DateTimeZone
+	 */
+	protected $_UTC_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_blog_DateTimeZone
+	 */
+	protected $_blog_DateTimeZone;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var mixed (null|string)
+	 */
+	protected $_date_time_output;
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
+	 *
+	 * @var string
+	 */
+	protected $_timezone_string;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected $_blog_offset;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @param string $timezone_string
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param string $pretty_date_format
+	 * @param string $pretty_time_format
+	 * @throws \EE_Error
+	 */
+	public function __construct(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$timezone_string = '',
+		$date_format = '',
+		$time_format = '',
+		$pretty_date_format = '',
+		$pretty_time_format = ''
+	) {
+
+		$this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
+		$this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
+		$this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
+		$this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaFormat('date-time');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_UTC_DateTimeZone()
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_blog_DateTimeZone()
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('');
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
+	 *
+	 * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
+	 *                                                              timestamp
+	 * @return DateTime
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output($pretty = false)
+	{
+
+		switch ($this->_date_time_output) {
+			case 'time' :
+				return $pretty ? $this->_pretty_time_format : $this->_time_format;
+				break;
+
+			case 'date' :
+				return $pretty ? $this->_pretty_date_format : $this->_date_format;
+				break;
+
+			default :
+				return $pretty
+					? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
+					: $this->_date_format . ' ' . $this->_time_format;
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string $what acceptable values are 'time' or 'date'.
+	 *                     Any other value will be set but will always result
+	 *                     in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output($what = null)
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string $timezone_string A valid timezone string as described by @link
+	 *                                http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone_string)
+	{
+		if (empty($timezone_string) && $this->_timezone_string !== null) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string $timezone_string
+	 * @return \DateTimeZone
+	 * @throws \EE_Error
+	 */
+	protected function _create_timezone_object_from_timezone_string($timezone_string = '')
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = $format;
+		} else {
+			$this->_date_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_date_format : $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = $format;
+		} else {
+			$this->_time_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_time_format : $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format($format)
+	{
+		$this->_pretty_date_format = $format;
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format($format)
+	{
+		$this->_pretty_time_format = $format;
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			);
+		} else {
+			//parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+
+		//make sure $current is in the correct timezone.
+		$current->setTimezone($this->_DateTimeZone);
+
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			);
+		} else {
+			//parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+
+		//make sure $current is in the correct timezone
+		$current->setTimezone($this->_DateTimeZone);
+
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
+	 * datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param  DateTime $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_get($DateTime)
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param mixed $DateTime
+	 * @param null  $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, $schema = null)
+	{
+		return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime    $DateTime
+	 * @param bool|string $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_for_display($DateTime, $schema = false)
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				} else {
+					$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				}
+			}
+		}
+		$format_string = $this->_get_date_time_output($schema);
+		//make sure datetime_value is in the correct timezone (in case that's been updated).
+		$DateTime->setTimezone($this->_DateTimeZone);
+		if ($schema) {
+			if ($this->_display_timezone()) {
+				//must be explicit because schema could equal true.
+				if ($schema === 'no_html') {
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+				}
+			} else {
+				$timezone_string = '';
+			}
+
+			return $DateTime->format($format_string) . $timezone_string;
+		} else {
+			return $DateTime->format($format_string);
+		}
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param  mixed $datetime_value u
+	 * @return string mysql timestamp in UTC
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_use_in_db($datetime_value)
+	{
+		//we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			throw new EE_Error(
+				__(
+					'The incoming value being prepared for setting in the database must either be empty or a php DateTime object',
+					'event_espresso'
+				)
+			);
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if ( ! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+
+			return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  mixed null | DateTime
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		//if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		if (empty($datetime_string)) {
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		} else {
+			$DateTime = DateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+			if ($DateTime instanceof \DateTime) {
+				$DateTime = new DbSafeDateTime(
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
+					$this->get_UTC_DateTimeZone()
+				);
+			}
+		}
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		$DateTime->setTimezone($this->_DateTimeZone);
+
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws \EE_Error
+	 */
+	protected function _display_timezone()
+	{
+
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
+	 *                                                    in the format that is set on the date_field (or DateTime
+	 *                                                    object)!
+	 * @return DateTime
+	 */
+	protected function _get_date_object($date_string)
+	{
+		//first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			$date_string->setTimezone($this->_DateTimeZone);
+
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		//not a unix timestamp.  So we will use the set format on this object and set timezone to
+		//create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if ($DateTime instanceof DateTime) {
+				$DateTime = new DbSafeDateTime(
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
+					$this->_DateTimeZone
+				);
+			}
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @param bool          $first_only
+	 * @return mixed
+	 */
+	public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
+	{
+		$time = is_int($time) || $time === null ? $time : strtotime($time);
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $DateTimeZone->getTransitions($time);
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
+	}
+
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		$transitions = $this->get_timezone_transitions($DateTimeZone, $time);
+		if ( ! isset($transitions['offset'])) {
+			throw new DomainException();
+		}
+		return $transitions['offset'];
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param  string $timezone_string
+	 * @return string           abbreviation
+	 * @throws \EE_Error
+	 */
+	public function get_timezone_abbrev($timezone_string)
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+
+		return $dateTime->format('T');
+	}
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		} else {
+			return parent::get_default_value();
+		}
+	}
+
+
+	public function getSchemaDescription()
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }

core/libraries/payment_methods/EEI_Payment_Method_Interfaces.php

Spacing +3 added lines, -3 removed lines

@@ -5,7 +5,7 @@ 
  *
  * allows gateways to be used by different systems other than Event Espresso
  */
-interface EEI_Payment extends EEI_Base{
+interface EEI_Payment extends EEI_Base {
 
 	/**
 	 * @return string indicating which the payment is approved, pending, cancelled or failed
@@ -153,7 +153,7 @@ 
 /**
  * Interface EEI_Payment_Method
  */
-interface EEI_Payment_Method{
+interface EEI_Payment_Method {
 
 }
 
@@ -172,7 +172,7 @@ 
 	 * @param string $model_name
 	 * @return EE_Log
 	 */
-	public function gateway_log($message,$id,$model_name);
+	public function gateway_log($message, $id, $model_name);
 }
 
 

Doc Comments +17 added lines, -2 removed lines

@@ -30,6 +30,7 @@ 
 	/**
 	 *
 	 * @param string $status
+	 * @return void
 	 */
 	public function set_status($status);
 
@@ -37,6 +38,7 @@ 
 	 * Sets the response from the gateway, which is displayable to the user.
 	 * Eg, 'payment was approved', 'payment failed because invalid date', etc.
 	 * @param string $response
+	 * @return void
 	 */
 	public function set_gateway_response($response);
 
@@ -44,6 +46,7 @@ 
 	 * Sets the response details, usually the entire contents of an IPN request,
 	 * or data about the direct payment data sent
 	 * @param mixed $response_details
+	 * @return void
 	 */
 	public function set_details($response_details);
 
@@ -56,12 +59,14 @@ 
 	/**
 	 * Sets the URl to redirect to, to process payment
 	 * @param string $url
+	 * @return void
 	 */
 	public function set_redirect_url($url);
 
 	/**
 	 * Sets the argument which should be passed to the redirect url (ie, usually POST variables)
 	 * @param array $args
+	 * @return void
 	 */
 	public function set_redirect_args($args);
 
@@ -80,25 +85,27 @@ 
 	/**
 	 * Sets the amount for this payment
 	 * @param float $amount
+	 * @return void
 	 */
 	public function set_amount($amount);
 
 	/**
 	 * Sets the ID of the gateway transaction
 	 * @param string $txn_id
+	 * @return void
 	 */
 	public function set_txn_id_chq_nmbr($txn_id);
 
 	/**
 	 * Sets a string for some extra accounting info
 	 * @param string $extra_accounting_info
+	 * @return void
 	 */
 	public function set_extra_accntng($extra_accounting_info);
 
     /**
      * Gets the first event for this payment (it's possible that it could be for multiple)
      *
-     * @param EE_Payment $payment
      * @return EE_Event|null
      */
     public function get_first_event();
@@ -106,7 +113,6 @@ 
     /**
      * Gets the name of the first event for which is being paid
      *
-     * @param EE_Payment $payment
      * @return string
      */
     public function get_first_event_name();
@@ -139,22 +145,27 @@ 
 interface EEMI_Payment {
 	/**
 	 * returns a string for the approved status
+	 * @return string
 	 */
 	public function approved_status();
 	/**
 	 * returns a string for the pending status
+	 * @return string
 	 */
 	public function pending_status();
 	/**
 	 * returns a string for the cancelled status
+	 * @return string
 	 */
 	public function cancelled_status();
 	/**
 	 * returns a string for the failed status
+	 * @return string
 	 */
 	public function failed_status();
 	/**
 	 * returns a string for the declined status
+	 * @return string
 	 */
 	public function declined_status();
 
@@ -208,6 +219,10 @@ 
  * Interface for an event being registered for
  */
 interface EEI_Event {
+
+	/**
+	 * @return boolean
+	 */
 	public function name();
 }
 

Indentation +28 added lines, -28 removed lines

@@ -95,34 +95,34 @@
 	 */
 	public function set_extra_accntng($extra_accounting_info);
 
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EE_Payment $payment
-     * @return EE_Event|null
-     */
-    public function get_first_event();
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function get_first_event_name();
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration();
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee();
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Event|null
+	 */
+	public function get_first_event();
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function get_first_event_name();
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration();
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee();
 }
 
 

core/db_models/EEM_Transaction.model.php

Spacing +14 added lines, -14 removed lines

@@ -1,7 +1,7 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 /**
  *
@@ -105,7 +105,7 @@ 
                     __('Registration Steps', 'event_espresso'), false, array()),
             )
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -167,7 +167,7 @@ 
             ),
             OBJECT,
             array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'txnDate' => array('DATE('.$query_interval.')', '%s'),
                 'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
             )
         );
@@ -187,17 +187,17 @@ 
     public function get_revenue_per_event_report($period = '-1 month')
     {
         global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $transaction_table          = $wpdb->prefix.'esp_transaction';
+        $registration_table         = $wpdb->prefix.'esp_registration';
+        $registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
+        $payment_table              = $wpdb->prefix.'esp_payment';
         $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status    = EEM_Payment::status_id_approved;
         $extra_event_on_join        = '';
         //exclude events not authored by user if permissions in effect
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
         
         return $wpdb->get_results(
@@ -268,7 +268,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
             '4.6.0'
@@ -316,7 +316,7 @@ 
             array(
                 0 => array(
                     'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
+                    'Payment.PAY_ID' => array('IS NULL'),
                     'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
                 )
             ),
@@ -334,18 +334,18 @@ 
             $time_to_leave_alone
         );
         //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
             // let's get deletin'...
             // Why no wpdb->prepare?  Because the data is trusted.
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+            $query = '
 				DELETE
-				FROM ' . $this->table() . '
+				FROM ' . $this->table().'
 				WHERE
-					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
+					TXN_ID IN ( ' . implode(",", $txn_ids).')';
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {

Indentation +363 added lines, -363 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Base.model.php');
 
@@ -15,193 +15,193 @@ 
 class EEM_Transaction extends EEM_Base
 {
 
-    // private instance of the Transaction object
-    protected static $_instance;
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
-     * but payment is pending. This is the state for transactions where payment is promised
-     * from an offline gateway.
-     */
-    //	const open_status_code = 'TPN';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
-     * either due to a technical reason (server or computer crash during registration),
-     *  or some other reason that prevent the collection of any useful contact information from any of the registrants
-     */
-    const failed_status_code = 'TFL';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
-     * either due to a technical reason (server or computer crash during registration),
-     * or due to an abandoned cart after registrant chose not to complete the registration process
-     * HOWEVER...
-     * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
-     * registrant
-     */
-    const abandoned_status_code = 'TAB';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
-     * meaning that monies are still owing: TXN_paid < TXN_total
-     */
-    const incomplete_status_code = 'TIN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
-     * meaning that NO monies are owing: TXN_paid == TXN_total
-     */
-    const complete_status_code = 'TCM';
-
-    /**
-     *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
-     *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
-     */
-    const overpaid_status_code = 'TOP';
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     *
-     * @return EEM_Transaction
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Transaction', 'event_espresso');
-        $this->plural_item   = __('Transactions', 'event_espresso');
-
-        $this->_tables                 = array(
-            'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
-        );
-        $this->_fields                 = array(
-            'TransactionTable' => array(
-                'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
-                'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
-                    __('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
-                    $timezone),
-                'TXN_total'        => new EE_Money_Field('TXN_total',
-                    __('Total value of Transaction', 'event_espresso'), false, 0),
-                'TXN_paid'         => new EE_Money_Field('TXN_paid',
-                    __('Amount paid towards transaction to date', 'event_espresso'), false, 0),
-                'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
-                    false, EEM_Transaction::failed_status_code, 'Status'),
-                'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
-                    __('Serialized session data', 'event_espresso'), true, ''),
-                'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
-                    __('Transaction Hash Salt', 'event_espresso'), true, ''),
-                'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
-                    __("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
-                'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
-                    __('Registration Steps', 'event_espresso'), false, array()),
-            )
-        );
-        $this->_model_relations        = array(
-            'Registration'   => new EE_Has_Many_Relation(),
-            'Payment'        => new EE_Has_Many_Relation(),
-            'Status'         => new EE_Belongs_To_Relation(),
-            'Line_Item'      => new EE_Has_Many_Relation(false),
-            //you can delete a transaction without needing to delete its line items
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Message'        => new EE_Has_Many_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-
-    }
-
-
-    /**
-     *    txn_status_array
-     * get list of transaction statuses
-     *
-     * @access public
-     * @return array
-     */
-    public static function txn_status_array()
-    {
-        return apply_filters(
-            'FHEE__EEM_Transaction__txn_status_array',
-            array(
-                EEM_Transaction::overpaid_status_code,
-                EEM_Transaction::complete_status_code,
-                EEM_Transaction::incomplete_status_code,
-                EEM_Transaction::abandoned_status_code,
-                EEM_Transaction::failed_status_code,
-            )
-        );
-    }
-
-    /**
-     *        get the revenue per day  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @return \stdClass[]
-     */
-    public function get_revenue_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s', 'UTC');
-
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
-
-        return $this->_get_all_wpdb_results(
-            array(
-                array(
-                    'TXN_timestamp' => array('>=', $sql_date)
-                ),
-                'group_by' => 'txnDate',
-                'order_by' => array('TXN_timestamp' => 'ASC')
-            ),
-            OBJECT,
-            array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
-            )
-        );
-    }
-
-
-    /**
-     *        get the revenue per event  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @throws \EE_Error
-     * @return mixed
-     */
-    public function get_revenue_per_event_report($period = '-1 month')
-    {
-        global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
-        $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
-        $approved_payment_status    = EEM_Payment::status_id_approved;
-        $extra_event_on_join        = '';
-        //exclude events not authored by user if permissions in effect
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
-        }
-
-        return $wpdb->get_results(
-            "SELECT
+	// private instance of the Transaction object
+	protected static $_instance;
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
+	 * but payment is pending. This is the state for transactions where payment is promised
+	 * from an offline gateway.
+	 */
+	//	const open_status_code = 'TPN';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
+	 * either due to a technical reason (server or computer crash during registration),
+	 *  or some other reason that prevent the collection of any useful contact information from any of the registrants
+	 */
+	const failed_status_code = 'TFL';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
+	 * either due to a technical reason (server or computer crash during registration),
+	 * or due to an abandoned cart after registrant chose not to complete the registration process
+	 * HOWEVER...
+	 * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
+	 * registrant
+	 */
+	const abandoned_status_code = 'TAB';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
+	 * meaning that monies are still owing: TXN_paid < TXN_total
+	 */
+	const incomplete_status_code = 'TIN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
+	 * meaning that NO monies are owing: TXN_paid == TXN_total
+	 */
+	const complete_status_code = 'TCM';
+
+	/**
+	 *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
+	 *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
+	 */
+	const overpaid_status_code = 'TOP';
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 *
+	 * @return EEM_Transaction
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Transaction', 'event_espresso');
+		$this->plural_item   = __('Transactions', 'event_espresso');
+
+		$this->_tables                 = array(
+			'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
+		);
+		$this->_fields                 = array(
+			'TransactionTable' => array(
+				'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
+				'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
+					__('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
+					$timezone),
+				'TXN_total'        => new EE_Money_Field('TXN_total',
+					__('Total value of Transaction', 'event_espresso'), false, 0),
+				'TXN_paid'         => new EE_Money_Field('TXN_paid',
+					__('Amount paid towards transaction to date', 'event_espresso'), false, 0),
+				'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
+					false, EEM_Transaction::failed_status_code, 'Status'),
+				'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
+					__('Serialized session data', 'event_espresso'), true, ''),
+				'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
+					__('Transaction Hash Salt', 'event_espresso'), true, ''),
+				'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
+					__("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
+				'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
+					__('Registration Steps', 'event_espresso'), false, array()),
+			)
+		);
+		$this->_model_relations        = array(
+			'Registration'   => new EE_Has_Many_Relation(),
+			'Payment'        => new EE_Has_Many_Relation(),
+			'Status'         => new EE_Belongs_To_Relation(),
+			'Line_Item'      => new EE_Has_Many_Relation(false),
+			//you can delete a transaction without needing to delete its line items
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Message'        => new EE_Has_Many_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+
+	}
+
+
+	/**
+	 *    txn_status_array
+	 * get list of transaction statuses
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function txn_status_array()
+	{
+		return apply_filters(
+			'FHEE__EEM_Transaction__txn_status_array',
+			array(
+				EEM_Transaction::overpaid_status_code,
+				EEM_Transaction::complete_status_code,
+				EEM_Transaction::incomplete_status_code,
+				EEM_Transaction::abandoned_status_code,
+				EEM_Transaction::failed_status_code,
+			)
+		);
+	}
+
+	/**
+	 *        get the revenue per day  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @return \stdClass[]
+	 */
+	public function get_revenue_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s', 'UTC');
+
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
+
+		return $this->_get_all_wpdb_results(
+			array(
+				array(
+					'TXN_timestamp' => array('>=', $sql_date)
+				),
+				'group_by' => 'txnDate',
+				'order_by' => array('TXN_timestamp' => 'ASC')
+			),
+			OBJECT,
+			array(
+				'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
+			)
+		);
+	}
+
+
+	/**
+	 *        get the revenue per event  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @throws \EE_Error
+	 * @return mixed
+	 */
+	public function get_revenue_per_event_report($period = '-1 month')
+	{
+		global $wpdb;
+		$transaction_table          = $wpdb->prefix . 'esp_transaction';
+		$registration_table         = $wpdb->prefix . 'esp_registration';
+		$registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		$event_table                = $wpdb->posts;
+		$payment_table              = $wpdb->prefix . 'esp_payment';
+		$sql_date                   = date('Y-m-d H:i:s', strtotime($period));
+		$approved_payment_status    = EEM_Payment::status_id_approved;
+		$extra_event_on_join        = '';
+		//exclude events not authored by user if permissions in effect
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+		}
+
+		return $wpdb->get_results(
+			"SELECT
 			Transaction_Event.event_name AS event_name,
 			SUM(Transaction_Event.paid) AS revenue
 			FROM
@@ -228,185 +228,185 @@ 
 					$extra_event_on_join
 				) AS Transaction_Event
 			GROUP BY event_name",
-            OBJECT
-        );
-    }
-
-
-    /**
-     * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
-     * $_REQUEST global variable. Either way, tries to find the current transaction (through
-     * the registration pointed to by reg_url_link), if not returns null
-     *
-     * @param string $reg_url_link
-     *
-     * @return EE_Transaction
-     */
-    public function get_transaction_from_reg_url_link($reg_url_link = '')
-    {
-        return $this->get_one(array(
-            array(
-                'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
-                    '')
-            )
-        ));
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * (or fetch the EE_Transaction from its ID)
-     *
-     * @deprecated
-     *
-     * @param EE_Transaction|int $transaction_obj_or_id
-     * @param boolean            $save_txn whether or not to save the transaction during this function call
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->ensure_is_obj($transaction_obj_or_id)
-        );
-    }
-
-    /**
-     * Deletes "junk" transactions that were probably added by bots. There might be TONS
-     * of these, so we are very careful to NOT select (which the models do even when deleting),
-     * and so we only use wpdb directly and only do minimal joins.
-     * Transactions are considered "junk" if they're failed for longer than a week.
-     * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
-     * it, it's probably not junk (regardless of what status it has).
-     * The downside to this approach is that is addons are listening for object deletions
-     * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
-     * to catch these types of deletions.
-     *
-     * @global WPDB $wpdb
-     * @return mixed
-     */
-    public function delete_junk_transactions()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $deleted             = false;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
-            , WEEK_IN_SECONDS
-        );
-
-
-        /**
-         * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
-         * Useful for plugins that want to exclude transactions matching certain query parameters.
-         * The query parameters should be in the format accepted by the EEM_Base model queries.
-         */
-        $ids_query = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
-            array(
-                0 => array(
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
-                    'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
-                )
-            ),
-            $time_to_leave_alone
-        );
-
-
-        /**
-         * This filter is for when code needs to filter the list of transaction ids that represent transactions
-         * about to be deleted based on some other criteria that isn't easily done via the query args filter.
-         */
-        $txn_ids = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
-            EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
-            $time_to_leave_alone
-        );
-        //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
-            // first, make sure these TXN's are removed the "ee_locked_transactions" array
-            EEM_Transaction::unset_locked_transactions($txn_ids);
-            // let's get deletin'...
-            // Why no wpdb->prepare?  Because the data is trusted.
-            // We got the ids from the original query to get them FROM
-            // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+			OBJECT
+		);
+	}
+
+
+	/**
+	 * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
+	 * $_REQUEST global variable. Either way, tries to find the current transaction (through
+	 * the registration pointed to by reg_url_link), if not returns null
+	 *
+	 * @param string $reg_url_link
+	 *
+	 * @return EE_Transaction
+	 */
+	public function get_transaction_from_reg_url_link($reg_url_link = '')
+	{
+		return $this->get_one(array(
+			array(
+				'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
+					'')
+			)
+		));
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * (or fetch the EE_Transaction from its ID)
+	 *
+	 * @deprecated
+	 *
+	 * @param EE_Transaction|int $transaction_obj_or_id
+	 * @param boolean            $save_txn whether or not to save the transaction during this function call
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->ensure_is_obj($transaction_obj_or_id)
+		);
+	}
+
+	/**
+	 * Deletes "junk" transactions that were probably added by bots. There might be TONS
+	 * of these, so we are very careful to NOT select (which the models do even when deleting),
+	 * and so we only use wpdb directly and only do minimal joins.
+	 * Transactions are considered "junk" if they're failed for longer than a week.
+	 * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
+	 * it, it's probably not junk (regardless of what status it has).
+	 * The downside to this approach is that is addons are listening for object deletions
+	 * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
+	 * to catch these types of deletions.
+	 *
+	 * @global WPDB $wpdb
+	 * @return mixed
+	 */
+	public function delete_junk_transactions()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$deleted             = false;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
+			, WEEK_IN_SECONDS
+		);
+
+
+		/**
+		 * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
+		 * Useful for plugins that want to exclude transactions matching certain query parameters.
+		 * The query parameters should be in the format accepted by the EEM_Base model queries.
+		 */
+		$ids_query = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
+			array(
+				0 => array(
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+					'Payment.PAY_ID' => array( 'IS NULL' ),
+					'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
+				)
+			),
+			$time_to_leave_alone
+		);
+
+
+		/**
+		 * This filter is for when code needs to filter the list of transaction ids that represent transactions
+		 * about to be deleted based on some other criteria that isn't easily done via the query args filter.
+		 */
+		$txn_ids = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
+			EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
+			$time_to_leave_alone
+		);
+		//now that we have the ids to delete
+		if (! empty($txn_ids) && is_array($txn_ids)) {
+			// first, make sure these TXN's are removed the "ee_locked_transactions" array
+			EEM_Transaction::unset_locked_transactions($txn_ids);
+			// let's get deletin'...
+			// Why no wpdb->prepare?  Because the data is trusted.
+			// We got the ids from the original query to get them FROM
+			// the db (which is sanitized) so no need to prepare them again.
+			$query   = '
 				DELETE
 				FROM ' . $this->table() . '
 				WHERE
 					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
-            $deleted = $wpdb->query($query);
-        }
-        if ($deleted) {
-            /**
-             * Allows code to do something after the transactions have been deleted.
-             */
-            do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
-        }
-
-        return $deleted;
-    }
-
-
-    /**
-     * @param array $transaction_IDs
-     *
-     * @return bool
-     */
-    public static function unset_locked_transactions(array $transaction_IDs)
-    {
-        $locked_transactions = get_option('ee_locked_transactions', array());
-        $update              = false;
-        foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[$TXN_ID])) {
-                unset($locked_transactions[$TXN_ID]);
-                $update = true;
-            }
-        }
-        if ($update) {
-            update_option('ee_locked_transactions', $locked_transactions);
-        }
-
-        return $update;
-    }
-
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is less than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws \EE_Error
-     */
-    public function get_transactions_in_progress()
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_timestamp' => array(
-                        '>',
-                        time() - EE_Registry::instance()->SSN->lifespan()
-                    ),
-                    'STS_ID' => array(
-                        '!=',
-                        EEM_Transaction::complete_status_code
-                    ),
-                )
-            )
-        );
-    }
+			$deleted = $wpdb->query($query);
+		}
+		if ($deleted) {
+			/**
+			 * Allows code to do something after the transactions have been deleted.
+			 */
+			do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
+		}
+
+		return $deleted;
+	}
+
+
+	/**
+	 * @param array $transaction_IDs
+	 *
+	 * @return bool
+	 */
+	public static function unset_locked_transactions(array $transaction_IDs)
+	{
+		$locked_transactions = get_option('ee_locked_transactions', array());
+		$update              = false;
+		foreach ($transaction_IDs as $TXN_ID) {
+			if (isset($locked_transactions[$TXN_ID])) {
+				unset($locked_transactions[$TXN_ID]);
+				$update = true;
+			}
+		}
+		if ($update) {
+			update_option('ee_locked_transactions', $locked_transactions);
+		}
+
+		return $update;
+	}
+
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is less than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws \EE_Error
+	 */
+	public function get_transactions_in_progress()
+	{
+		return $this->get_all(
+			array(
+				array(
+					'TXN_timestamp' => array(
+						'>',
+						time() - EE_Registry::instance()->SSN->lifespan()
+					),
+					'STS_ID' => array(
+						'!=',
+						EEM_Transaction::complete_status_code
+					),
+				)
+			)
+		);
+	}
 
 
 }

core/db_classes/EE_Base_Class.class.php

Doc Comments +9 added lines, -8 removed lines

@@ -574,7 +574,7 @@ 
      *
      * @param \EE_Datetime_Field $datetime_field
      * @param bool               $pretty
-     * @param null $date_or_time
+     * @param string|null $date_or_time
      * @return void
      * @throws \EE_Error
      */
@@ -892,7 +892,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
      *                                  you can indicate just the columns you want returned
      * @return array|EE_Base_Class
      * @throws \EE_Error
@@ -917,7 +917,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
      *                                  you can indicate just the column you want returned
      * @return array|EE_Base_Class
      * @throws \EE_Error
@@ -990,7 +990,7 @@ 
      * This method simply returns the RAW unprocessed value for the given property in this class
      *
      * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
+     * @return integer|null              Whatever the raw value stored on the property is.
      * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
      */
     public function get_raw($field_name)
@@ -1256,7 +1256,7 @@ 
      * sets the time on a datetime property
      *
      * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+     * @param string $time      a valid time string for php datetime functions (or DateTime object)
      * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
      * @throws \EE_Error
      */
@@ -1271,7 +1271,7 @@ 
      * sets the date on a datetime property
      *
      * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+     * @param string $date      a valid date string for php datetime functions ( or DateTime object)
      * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
      * @throws \EE_Error
      */
@@ -1329,6 +1329,7 @@ 
      * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
      * @param string               $prepend    You can include something to prepend on the timestamp
      * @param string               $append     You can include something to append on the timestamp
+     * @param string $args
      * @throws EE_Error
      * @return string timestamp
      */
@@ -1699,7 +1700,7 @@ 
      *
      * @param  array  $props_n_values   incoming array of properties and their values
      * @param  string $classname        the classname of the child class
-     * @param null    $timezone
+     * @param string|null    $timezone
      * @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 mixed (EE_Base_Class|bool)
@@ -1777,7 +1778,7 @@ 
      * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
      *
      * @param string $model_classname
-     * @param null   $timezone
+     * @param string|null   $timezone
      * @return EEM_Base
      */
     protected static function _get_model_instance_with_name($model_classname, $timezone = null)

Spacing +18 added lines, -18 removed lines

@@ -145,8 +145,8 @@ 
             list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
         } else {
             //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+            $this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
+            $this->_tm_frmt = (string) get_option('time_format', 'g:i a');
         }
         //if db model is instantiating
         if ($bydb) {
@@ -457,7 +457,7 @@ 
      */
     public function get_format($full = true)
     {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
     }
 
 
@@ -565,7 +565,7 @@ 
         //verify the field exists
         $this->get_model()->field_settings_for($fieldname);
         $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
         if (isset($this->_cached_properties[$fieldname][$cache_type])) {
             return $this->_cached_properties[$fieldname][$cache_type];
         }
@@ -780,7 +780,7 @@ 
         $current_cache_id = ''
     ) {
         // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
+        $obj_class = 'EE_'.$relationName;
         if ($newly_saved_object instanceof $obj_class) {
             /* @type EE_Base_Class $newly_saved_object */
             // now get the type of relation
@@ -1259,7 +1259,7 @@ 
      */
     public function get_i18n_datetime($field_name, $format = '')
     {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
         return date_i18n(
             $format,
             EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
@@ -1397,8 +1397,8 @@ 
         }
         $original_timezone = $this->_timezone;
         $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
+        $fn = (array) $field_name;
+        $args = array_merge($fn, (array) $args);
         if ( ! method_exists($this, $callback)) {
             throw new EE_Error(
                 sprintf(
@@ -1410,8 +1410,8 @@ 
                 )
             );
         }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+        $args = (array) $args;
+        $return = $prepend.call_user_func_array(array($this, $callback), $args).$append;
         $this->set_timezone($original_timezone);
         return $return;
     }
@@ -1548,7 +1548,7 @@ 
          * @param array         $set_cols_n_values
          * @param EE_Base_Class $model_object
          */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+        $set_cols_n_values = (array) apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
             $this);
         //set attributes as provided in $set_cols_n_values
         foreach ($set_cols_n_values as $column => $value) {
@@ -1603,8 +1603,8 @@ 
                                 __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
                                     'event_espresso'),
                                 get_class($this),
-                                get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                                get_class($this->get_model()) . '::instance()->get_one_by_ID()',
+                                get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                                get_class($this->get_model()).'::instance()->get_one_by_ID()',
                                 '<br />'
                             )
                         );
@@ -1871,7 +1871,7 @@ 
         if (strpos($model_name, "EE_") === 0) {
             $model_classname = str_replace("EE_", "EEM_", $model_name);
         } else {
-            $model_classname = "EEM_" . $model_name;
+            $model_classname = "EEM_".$model_name;
         }
         return $model_classname;
     }
@@ -2255,7 +2255,7 @@ 
      */
     protected function _property_exists($properties)
     {
-        foreach ((array)$properties as $property_name) {
+        foreach ((array) $properties as $property_name) {
             //first make sure this property exists
             if ( ! $this->_fields[$property_name]) {
                 throw new EE_Error(
@@ -2586,8 +2586,8 @@ 
                         __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
                             'event_espresso'),
                         $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
                     )
                 );
             }
@@ -2646,7 +2646,7 @@ 
     {
         foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $this->get_model()->get_this_model_name();
+                $classname = 'EE_'.$this->get_model()->get_this_model_name();
                 if (
                     $this->get_one_from_cache($relation_name) instanceof $classname
                     && $this->get_one_from_cache($relation_name)->ID()

Indentation +2650 added lines, -2650 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, ' FILE LOADED', '');
 
@@ -25,2655 +25,2655 @@ 
 abstract class EE_Base_Class
 {
 
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     *
-     * @var array
-     */
-    protected $_props_n_values_provided_in_constructor;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     *
-     * @var string $_dt_frmt
-     */
-    protected $_dt_frmt;
-
-
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     *
-     * @var string $_tm_frmt
-     */
-    protected $_tm_frmt;
-
-
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     *
-     * @var array
-     */
-    protected $_cached_properties = array();
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     *
-     * @var array
-     */
-    protected $_model_relations = array();
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     *
-     * @var array
-     */
-    protected $_fields = array();
-
-    /**
-     * @var boolean indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected $_allow_persist = true;
-
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model = $this->get_model();
-        $model_fields = $model->field_settings(false);
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
-        // EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if ( ! isset($model_fields[$field_name])) {
-                throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
-                    "event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
-            }
-        }
-        // EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if ( ! empty($date_formats) && is_array($date_formats)) {
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
-        } else {
-            //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
-        }
-        //if db model is instantiating
-        if ($bydb) {
-            //client code has indicated these field values are from the database
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
-            }
-        } else {
-            //we're constructing a brand
-            //new instance of the model object. Generally, this means we'll need to do more field validation
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
-            }
-        }
-        //remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        //remember in entity mapper
-        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        //setup all the relations
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[$relation_name] = null;
-            } else {
-                $this->_model_relations[$relation_name] = array();
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @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)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                $field_obj->set_date_format($this->_dt_frmt);
-                $field_obj->set_time_format($this->_tm_frmt);
-            }
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
-            //should the value be null?
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[$field_name] = $field_obj->get_default_value();
-                /**
-                 * To save having to refactor all the models, if a default value is used for a
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
-                 * object.
-                 *
-                 * @since 4.6.10+
-                 */
-                if (
-                    $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[$field_name] !== null
-                    && ! $this->_fields[$field_name] instanceof DateTime
-                ) {
-                    empty($this->_fields[$field_name])
-                        ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[$field_name]);
-                }
-            } else {
-                $this->_fields[$field_name] = $holder_of_value;
-            }
-            //if we're not in the constructor...
-            //now check if what we set was a primary key
-            if (
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
-                $this->_props_n_values_provided_in_constructor
-                && $field_value
-                && $field_name === self::_get_primary_key_name(get_class($this))
-            ) {
-                //if so, we want all this object's fields to be filled either with
-                //what we've explicitly set on this model
-                //or what we have in the db
-                // echo "setting primary key!";
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
-                $obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-                foreach ($fields_on_model as $field_obj) {
-                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                         && $field_obj->get_name() !== $field_name
-                    ) {
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                    }
-                }
-                //oh this model object has an ID? well make sure its in the entity mapper
-                $this->get_model()->add_to_entity_map($this);
-            }
-            //let's unset any cache for this field_name from the $_cached_properties property.
-            $this->_clear_cached_property($field_name);
-        } else {
-            throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
-                "event_espresso"), $field_name));
-        }
-    }
-
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws \EE_Error
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        } else {
-            //ensure this object is saved first so that extra meta can be properly related.
-            $this->save();
-            return $this->update_extra_meta($field_name, $field_value);
-        }
-    }
-
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param  string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws \EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            //This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        //make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        //make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
-                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_date_format($format)
-    {
-        $this->_dt_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_time_format($format)
-    {
-        $this->_tm_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return mixed string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
-    }
-
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @throws EE_Error
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                  related thing, no array)
-     */
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if ( ! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
-            throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                $relationName, get_class($this)));
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[$relationName] = $object_to_cache;
-            $return = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
-            if ( ! is_array($this->_model_relations[$relationName])) {
-                // if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
-                    ? array($this->_model_relations[$relationName]) : array();
-            }
-            // first check for a cache_id which is normally empty
-            if ( ! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
-                $return = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
-                $return = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[$relationName][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[$relationName]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[$relationName]);
-            }
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        //first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[$fieldname][$cache_type] = $value;
-    }
-
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws \EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        //verify the field exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
-            return $this->_cached_properties[$fieldname][$cache_type];
-        }
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-            }
-            if ( ! isset($this->_fields[$fieldname])) {
-                $this->_fields[$fieldname] = null;
-            }
-            $value = $pretty
-                ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
-                : $field_obj->prepare_for_get($this->_fields[$fieldname]);
-            $this->_set_cached_property($fieldname, $value, $cache_type);
-            return $value;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param \EE_Datetime_Field $datetime_field
-     * @param bool               $pretty
-     * @param null $date_or_time
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        //set the output returned
-        switch ($date_or_time) {
-            case 'D' :
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T' :
-                $datetime_field->set_date_time_output('time');
-                break;
-            default :
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = array();
-    }
-
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[$property_name])) {
-            unset($this->_cached_properties[$property_name]);
-        }
-    }
-
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
-     *                       relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-        $index_in_cache = '';
-        if ( ! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    __("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed = true;
-            $this->_model_relations[$relationName] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed = $this->_model_relations[$relationName];
-            $this->_model_relations[$relationName] = null;
-        } else {
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[$relationName])
-                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
-                ) {
-                    $index_found_at = null;
-                    //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        //if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            //supposedly we've found it. But it could just be that the client code
-            //provided a bad index/object
-            if (
-            isset(
-                $this->_model_relations[$relationName],
-                $this->_model_relations[$relationName][$index_in_cache]
-            )
-            ) {
-                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
-                unset($this->_model_relations[$relationName][$index_in_cache]);
-            } else {
-                //that thing was never cached anyways.
-                $obj_removed = null;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string         $relationName       - the type of object that is cached
-     * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string         $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relationName,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[$relationName] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            } elseif (is_array($this->_model_relations[$relationName])
-                      && isset($this->_model_relations[$relationName][$current_cache_id])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[$relationName][$current_cache_id]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relationName)
-    {
-        $cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
-            : null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        } else {
-            return $cached_array_or_object;
-        }
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @throws \EE_Error
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     */
-    public function get_all_from_cache($relationName)
-    {
-        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects) ? $objects : array($objects);
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        //basically, if this model object was stored in the session, and these cached model objects
-        //already have IDs, let's make sure they're in their model's entity mapper
-        //otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relationName);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relationName,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $columns_to_select = null
-    ) {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws \EE_Error
-     */
-    public function set_from_db($field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
-            //eg, a CPT model object could have an entry in the posts table, but no
-            //entry in the meta table. Meaning that all its columns in the meta table
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    //if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[$field_name] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
-            ? $this->_fields[$field_name]->format('U')
-            : $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws \EE_Error
-     *                                         an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo $this->get_pretty($field_name, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws \EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-
-    /**
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
-     * to see what options are available.
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string   $dt_frmt      valid datetime format used for date
-     *                               (if '' then we just use the default on the field,
-     *                               if NULL we use the last-used format)
-     * @param string   $tm_frmt      Same as above except this is for time format
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                               if field is not a valid dtt field, or void if echoing
-     * @throws \EE_Error
-     */
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
-    {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        //reset format properties because they are used in get()
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @throws \EE_Error
-     */
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
-    }
-
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
-     *
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws \EE_Error
-     *                           field name.
-     */
-    public function get_i18n_datetime($field_name, $format = '')
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
-        );
-    }
-
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param  string $field_name The field name being checked
-     * @throws EE_Error
-     * @return EE_Datetime_Field
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        //check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        } else {
-            throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
-        }
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws \EE_Error
-     */
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
-    {
-        $field = $this->_get_dtt_field_settings($fieldname);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'D' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'B' :
-                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
-                break;
-        }
-        $this->_clear_cached_property($fieldname);
-    }
-
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string               $field_name This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string               $prepend    You can include something to prepend on the timestamp
-     * @param string               $append     You can include something to append on the timestamp
-     * @throws EE_Error
-     * @return string timestamp
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
-        if ( ! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return boolean | int
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $result = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return bool|int
-     * @throws \EE_Error
-     */
-    protected function _delete()
-    {
-        return $this->delete_permanently();
-    }
-
-
-
-    /**
-     * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
-     * error)
-     *
-     * @return bool | int
-     * @throws \EE_Error
-     */
-    public function delete_permanently()
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws \EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ( ! empty($this->_model_relations[$relation_name])) {
-                $related_objects = $this->_model_relations[$relation_name];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //this relation only stores a single model object, not an array
-                    //but let's make it consistent
-                    $related_objects = array($related_objects);
-                }
-                foreach ($related_objects as $related_object) {
-                    //only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @throws \EE_Error
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
-     */
-    public function save($set_cols_n_values = array())
-    {
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
-            $this);
-        //set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if ( ! $this->allow_persist()) {
-            return 0;
-        }
-        //now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        //if the object already has an ID, update it. Otherwise, insert it
-        //also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
-        $old_assumption_concerning_value_preparation = $this->get_model()
-                                                            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->get_model()->assume_values_already_prepared_by_model_object(true);
-        //does this model have an autoincrement PK?
-        if ($this->get_model()->has_primary_key_field()) {
-            if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
-                //ok check if it's set, if so: update; if not, insert
-                if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    if ($results) {
-                        //if successful, set the primary key
-                        //but don't use the normal SET method, because it will check if
-                        //an item with the same ID exists in the mapper & db, then
-                        //will find it in the db (because we just added it) and THAT object
-                        //will get added to the mapper before we can add this one!
-                        //but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name = self::_get_primary_key_name(get_class($this));
-                        $this->_fields[$pk_field_name] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $this->get_model()->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {//PK is NOT auto-increment
-                //so check if one like it already exists in the db
-                if ($this->get_model()->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'),
-                                get_class($this),
-                                get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                                get_class($this->get_model()) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {//there is NO primary key
-            $already_in_db = false;
-            foreach ($this->get_model()->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($this->get_model()->exists(array($uniqueness_where_params))) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
-                    $this->get_model()->get_combined_primary_key_fields());
-                $results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
-            } else {
-                $results = $this->get_model()->insert($save_cols_n_values);
-            }
-        }
-        //restore the old assumption about values being prepared by the model object
-        $this->get_model()
-             ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        return $results;
-    }
-
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $this->get_model()->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws \EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        //make sure this has been saved
-        if ( ! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[$relationName]) {
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
-                    //but ONLY if it DOES NOT exist in the DB
-                    /* @var $related_model_obj EE_Base_Class */
-                    $related_model_obj = $this->_model_relations[$relationName];
-                    //					if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relationName);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    //					}
-                } else {
-                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
-                        //but ONLY if it DOES NOT exist in the DB
-                        //						if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relationName);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        //						}
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return \EEM_Base | \EEM_CPT_Base
-     */
-    public function get_model()
-    {
-        $modelName = self::_get_model_classname(get_class($this));
-        return self::_get_model_instance_with_name($modelName, $this->_timezone);
-    }
-
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws \EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        //TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
-            $id = $props_n_values[$primary_id_ref];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param  array  $props_n_values   incoming array of properties and their values
-     * @param  string $classname        the classname of the child class
-     * @param null    $timezone
-     * @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 mixed (EE_Base_Class|bool)
-     * @throws \EE_Error
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
-    {
-        $existing = null;
-        if (self::_get_model($classname)->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[$primary_id_ref])
-            ) {
-                $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                    $props_n_values[$primary_id_ref]
-                );
-            }
-        } elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
-            //no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            //set date formats if present before setting values
-            if ( ! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                //set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    protected static function _get_model($classname, $timezone = null)
-    {
-        //find model for this class
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "What were you thinking calling _get_model(%s)?? You need to specify the class name",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = null)
-    {
-        if (strpos($model_name, "EE_") === 0) {
-            $model_classname = str_replace("EE_", "EEM_", $model_name);
-        } else {
-            $model_classname = "EEM_" . $model_name;
-        }
-        return $model_classname;
-    }
-
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @throws EE_Error
-     * @return string
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws \EE_Error
-     */
-    public function ID()
-    {
-        //now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($this->get_model()->has_primary_key_field()) {
-            return $this->_fields[self::_get_primary_key_name(get_class($this))];
-        } else {
-            return $this->get_model()->get_index_primary_key_string($this->_fields);
-        }
-    }
-
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relationName                     eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @throws EE_Error
-     * @return EE_Base_Class the object the relation was added to
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = array(),
-        $cache_id = null
-    ) {
-        //if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $this->get_model()
-                                ->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $extra_join_model_fields_n_values);
-            //clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relationName, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        } else {
-            //this thing doesn't exist in the DB,  so just cache it
-            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(sprintf(
-                    __('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                        'event_espresso'),
-                    $otherObjectModelObjectOrID,
-                    get_class($this)
-                ));
-            } else {
-                $otherObject = $otherObjectModelObjectOrID;
-            }
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            //fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                //its saved so assumed relations exist in the DB, so we can just
-                //clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
-            } else {
-                //it's not saved, so it caches relations like this
-                $otherObject->cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relationName
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
-     *                created in the join table.
-     * @return EE_Base_Class the relation was removed from
-     * @throws \EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()
-                                ->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $where_query);
-            $this->clear_cache($relationName, $otherObject);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function _remove_relations($relationName, $where_query_params = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
-            $this->clear_cache($relationName, null, true);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache($relationName, null, true);
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObjects;
-    }
-
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
-     * @throws \EE_Error
-     *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
-     *                             you want IDs
-     */
-    public function get_many_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            //this exists in the DB, so get the related things from either the cache or the DB
-            //if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-            } else {
-                //did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relationName);
-                if ( ! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-                    //if no query parameters were passed, then we got all the related model objects
-                    //for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relationName, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            //this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relationName);
-        }
-        return $related_model_objects;
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   like EEM_Base::get_all's
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  like EEM_Base::get_all's
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key (which doesn't make much sense, so you should probably
-     *                              change it)
-     * @return int
-     */
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class (not an array, a single object)
-     * @throws \EE_Error
-     */
-    public function get_first_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
-            //if they've provided some query parameters, don't bother trying to cache the result
-            //also make sure we're not caching the result of get_first_related
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
-            if ($query_params
-                || ! $this->get_model()->related_settings_for($relationName)
-                     instanceof
-                     EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            } else {
-                //first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relationName);
-                if ( ! $cached_result) {
-                    $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-                    $this->cache($relationName, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            //this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
-            if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            }
-            //this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
-            if ( ! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relationName);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-
-    /**
-     * Does a delete on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted
-     * @throws \EE_Error
-     */
-    public function delete_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-            $this->clear_cache($relationName, null, true);
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted (including those soft deleted)
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-        }
-        $this->clear_cache($relationName, null, true);
-        return $count;
-    }
-
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param  string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[$field_name]);
-    }
-
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param  mixed (string|array) $properties properties to check
-     * @throws EE_Error
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array)$properties as $property_name) {
-            //first make sure this property exists
-            if ( ! $this->_fields[$property_name]) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields = $this->get_model()->field_settings(false);
-        $properties = array();
-        //remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[$field_name] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
-     * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
-     * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EE_Answer.class.php');
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
-     * echo $answer->my_callback('monkeys',100);
-     * //will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if ( ! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        "event_espresso"
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @param string $previous_value
-     * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     * @throws \EE_Error
-     * NOTE: if the values haven't changed, returns 0
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if ( ! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        } else {
-            foreach ($existing_rows_like_that as $existing_row) {
-                $existing_row->save(array('EXM_value' => $meta_value));
-            }
-            return count($existing_rows_like_that);
-        }
-    }
-
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param string  $meta_value
-     * @param boolean $unique
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                array(
-                    array(
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ),
-                )
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            array(
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            )
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws \EE_Error
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     * @throws \EE_Error
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null)
-    {
-        if ($single) {
-            $result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            } else {
-                return $default;
-            }
-        } else {
-            $results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($results) {
-                $values = array();
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[$result->ID()] = $result->value();
-                    }
-                }
-                return $values;
-            } else {
-                return $default;
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param boolean $one_of_each_key
-     * @return array
-     * @throws \EE_Error
-     */
-    public function all_extra_meta_array($one_of_each_key = true)
-    {
-        $return_array = array();
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
-                        $return_array[$extra_meta_obj->key()] = array();
-                    }
-                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        //find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        } else {
-            $first_few_properties = $this->model_field_array();
-            $first_few_properties = array_slice($first_few_properties, 0, 3);
-            $name_parts = array();
-            foreach ($first_few_properties as $name => $value) {
-                $name_parts[] = "$name:$value";
-            }
-            return implode(",", $name_parts);
-        }
-    }
-
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function in_entity_map()
-    {
-        if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
-            //well, if we looked, did we find it in the entity map?
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            //absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $this->get_model()->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = array();
-        return array_keys(get_object_vars($this));
-    }
-
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 *
+	 * @var array
+	 */
+	protected $_props_n_values_provided_in_constructor;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 *
+	 * @var string $_dt_frmt
+	 */
+	protected $_dt_frmt;
+
+
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 *
+	 * @var string $_tm_frmt
+	 */
+	protected $_tm_frmt;
+
+
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 *
+	 * @var array
+	 */
+	protected $_cached_properties = array();
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 *
+	 * @var array
+	 */
+	protected $_model_relations = array();
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 *
+	 * @var array
+	 */
+	protected $_fields = array();
+
+	/**
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected $_allow_persist = true;
+
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model = $this->get_model();
+		$model_fields = $model->field_settings(false);
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
+		// EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if ( ! isset($model_fields[$field_name])) {
+				throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
+					"event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
+			}
+		}
+		// EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if ( ! empty($date_formats) && is_array($date_formats)) {
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
+		} else {
+			//set default formats for date and time
+			$this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
+			$this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+		}
+		//if db model is instantiating
+		if ($bydb) {
+			//client code has indicated these field values are from the database
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
+			}
+		} else {
+			//we're constructing a brand
+			//new instance of the model object. Generally, this means we'll need to do more field validation
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
+			}
+		}
+		//remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		//remember in entity mapper
+		if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		//setup all the relations
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[$relation_name] = null;
+			} else {
+				$this->_model_relations[$relation_name] = array();
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (isset($this->_props_n_values_provided_in_constructor[$field_name])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @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)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				$field_obj->set_date_format($this->_dt_frmt);
+				$field_obj->set_time_format($this->_tm_frmt);
+			}
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
+			//should the value be null?
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
+				$this->_fields[$field_name] = $field_obj->get_default_value();
+				/**
+				 * To save having to refactor all the models, if a default value is used for a
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
+				 * object.
+				 *
+				 * @since 4.6.10+
+				 */
+				if (
+					$field_obj instanceof EE_Datetime_Field
+					&& $this->_fields[$field_name] !== null
+					&& ! $this->_fields[$field_name] instanceof DateTime
+				) {
+					empty($this->_fields[$field_name])
+						? $this->set($field_name, time())
+						: $this->set($field_name, $this->_fields[$field_name]);
+				}
+			} else {
+				$this->_fields[$field_name] = $holder_of_value;
+			}
+			//if we're not in the constructor...
+			//now check if what we set was a primary key
+			if (
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
+				$this->_props_n_values_provided_in_constructor
+				&& $field_value
+				&& $field_name === self::_get_primary_key_name(get_class($this))
+			) {
+				//if so, we want all this object's fields to be filled either with
+				//what we've explicitly set on this model
+				//or what we have in the db
+				// echo "setting primary key!";
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
+				$obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+				foreach ($fields_on_model as $field_obj) {
+					if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+						 && $field_obj->get_name() !== $field_name
+					) {
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+					}
+				}
+				//oh this model object has an ID? well make sure its in the entity mapper
+				$this->get_model()->add_to_entity_map($this);
+			}
+			//let's unset any cache for this field_name from the $_cached_properties property.
+			$this->_clear_cached_property($field_name);
+		} else {
+			throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
+				"event_espresso"), $field_name));
+		}
+	}
+
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws \EE_Error
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		} else {
+			//ensure this object is saved first so that extra meta can be properly related.
+			$this->save();
+			return $this->update_extra_meta($field_name, $field_value);
+		}
+	}
+
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param  string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws \EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			//This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		//make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		//make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+					$this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_date_format($format)
+	{
+		$this->_dt_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_time_format($format)
+	{
+		$this->_tm_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return mixed string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+	}
+
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @throws EE_Error
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                  related thing, no array)
+	 */
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if ( ! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+			throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+				$relationName, get_class($this)));
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[$relationName] = $object_to_cache;
+			$return = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
+			if ( ! is_array($this->_model_relations[$relationName])) {
+				// if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
+					? array($this->_model_relations[$relationName]) : array();
+			}
+			// first check for a cache_id which is normally empty
+			if ( ! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[$relationName][$cache_id] = $object_to_cache;
+				$return = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
+				$return = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[$relationName][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[$relationName]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[$relationName]);
+			}
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		//first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
+		$this->_cached_properties[$fieldname][$cache_type] = $value;
+	}
+
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws \EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		//verify the field exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+			return $this->_cached_properties[$fieldname][$cache_type];
+		}
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+			}
+			if ( ! isset($this->_fields[$fieldname])) {
+				$this->_fields[$fieldname] = null;
+			}
+			$value = $pretty
+				? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+				: $field_obj->prepare_for_get($this->_fields[$fieldname]);
+			$this->_set_cached_property($fieldname, $value, $cache_type);
+			return $value;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param \EE_Datetime_Field $datetime_field
+	 * @param bool               $pretty
+	 * @param null $date_or_time
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		//set the output returned
+		switch ($date_or_time) {
+			case 'D' :
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T' :
+				$datetime_field->set_date_time_output('time');
+				break;
+			default :
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = array();
+	}
+
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[$property_name])) {
+			unset($this->_cached_properties[$property_name]);
+		}
+	}
+
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
+	 *                       relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+		$index_in_cache = '';
+		if ( ! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					__("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed = true;
+			$this->_model_relations[$relationName] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed = $this->_model_relations[$relationName];
+			$this->_model_relations[$relationName] = null;
+		} else {
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (is_array($this->_model_relations[$relationName])
+					&& ! isset($this->_model_relations[$relationName][$index_in_cache])
+				) {
+					$index_found_at = null;
+					//find this object in the array even though it has a different key
+					foreach ($this->_model_relations[$relationName] as $index => $obj) {
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						//if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			//supposedly we've found it. But it could just be that the client code
+			//provided a bad index/object
+			if (
+			isset(
+				$this->_model_relations[$relationName],
+				$this->_model_relations[$relationName][$index_in_cache]
+			)
+			) {
+				$obj_removed = $this->_model_relations[$relationName][$index_in_cache];
+				unset($this->_model_relations[$relationName][$index_in_cache]);
+			} else {
+				//that thing was never cached anyways.
+				$obj_removed = null;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string         $relationName       - the type of object that is cached
+	 * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string         $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relationName,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relationName;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[$relationName] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			} elseif (is_array($this->_model_relations[$relationName])
+					  && isset($this->_model_relations[$relationName][$current_cache_id])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[$relationName][$current_cache_id]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relationName)
+	{
+		$cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
+			: null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		} else {
+			return $cached_array_or_object;
+		}
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @throws \EE_Error
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 */
+	public function get_all_from_cache($relationName)
+	{
+		$objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects) ? $objects : array($objects);
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		//basically, if this model object was stored in the session, and these cached model objects
+		//already have IDs, let's make sure they're in their model's entity mapper
+		//otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relationName);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relationName,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$columns_to_select = null
+	) {
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws \EE_Error
+	 */
+	public function set_from_db($field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
+			//eg, a CPT model object could have an entry in the posts table, but no
+			//entry in the meta table. Meaning that all its columns in the meta table
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					//if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[$field_name] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param  string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+			? $this->_fields[$field_name]->format('U')
+			: $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws \EE_Error
+	 *                                         an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo $this->get_pretty($field_name, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+
+	/**
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
+	 * to see what options are available.
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string   $dt_frmt      valid datetime format used for date
+	 *                               (if '' then we just use the default on the field,
+	 *                               if NULL we use the last-used format)
+	 * @param string   $tm_frmt      Same as above except this is for time format
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                               if field is not a valid dtt field, or void if echoing
+	 * @throws \EE_Error
+	 */
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
+	{
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		//reset format properties because they are used in get()
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @throws \EE_Error
+	 */
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
+	}
+
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
+	 *
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws \EE_Error
+	 *                           field name.
+	 */
+	public function get_i18n_datetime($field_name, $format = '')
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
+		);
+	}
+
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param  string $field_name The field name being checked
+	 * @throws EE_Error
+	 * @return EE_Datetime_Field
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		//check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		} else {
+			throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+				'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
+		}
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
+	{
+		$field = $this->_get_dtt_field_settings($fieldname);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'D' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'B' :
+				$this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
+				break;
+		}
+		$this->_clear_cached_property($fieldname);
+	}
+
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string               $field_name This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string               $prepend    You can include something to prepend on the timestamp
+	 * @param string               $append     You can include something to append on the timestamp
+	 * @throws EE_Error
+	 * @return string timestamp
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn = (array)$field_name;
+		$args = array_merge($fn, (array)$args);
+		if ( ! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args = (array)$args;
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return boolean | int
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$result = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return bool|int
+	 * @throws \EE_Error
+	 */
+	protected function _delete()
+	{
+		return $this->delete_permanently();
+	}
+
+
+
+	/**
+	 * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
+	 * error)
+	 *
+	 * @return bool | int
+	 * @throws \EE_Error
+	 */
+	public function delete_permanently()
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws \EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ( ! empty($this->_model_relations[$relation_name])) {
+				$related_objects = $this->_model_relations[$relation_name];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//this relation only stores a single model object, not an array
+					//but let's make it consistent
+					$related_objects = array($related_objects);
+				}
+				foreach ($related_objects as $related_object) {
+					//only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @throws \EE_Error
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+			$this);
+		//set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if ( ! $this->allow_persist()) {
+			return 0;
+		}
+		//now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		//if the object already has an ID, update it. Otherwise, insert it
+		//also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
+		$old_assumption_concerning_value_preparation = $this->get_model()
+															->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->get_model()->assume_values_already_prepared_by_model_object(true);
+		//does this model have an autoincrement PK?
+		if ($this->get_model()->has_primary_key_field()) {
+			if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
+				//ok check if it's set, if so: update; if not, insert
+				if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
+					$results = $this->get_model()->insert($save_cols_n_values);
+					if ($results) {
+						//if successful, set the primary key
+						//but don't use the normal SET method, because it will check if
+						//an item with the same ID exists in the mapper & db, then
+						//will find it in the db (because we just added it) and THAT object
+						//will get added to the mapper before we can add this one!
+						//but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name = self::_get_primary_key_name(get_class($this));
+						$this->_fields[$pk_field_name] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$this->get_model()->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {//PK is NOT auto-increment
+				//so check if one like it already exists in the db
+				if ($this->get_model()->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								__('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'),
+								get_class($this),
+								get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+								get_class($this->get_model()) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $this->get_model()->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {//there is NO primary key
+			$already_in_db = false;
+			foreach ($this->get_model()->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($this->get_model()->exists(array($uniqueness_where_params))) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
+					$this->get_model()->get_combined_primary_key_fields());
+				$results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
+			} else {
+				$results = $this->get_model()->insert($save_cols_n_values);
+			}
+		}
+		//restore the old assumption about values being prepared by the model object
+		$this->get_model()
+			 ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		return $results;
+	}
+
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$this->get_model()->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws \EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		//make sure this has been saved
+		if ( ! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
+			if ($this->_model_relations[$relationName]) {
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					//add a relation to that relation type (which saves the appropriate thing in the process)
+					//but ONLY if it DOES NOT exist in the DB
+					/* @var $related_model_obj EE_Base_Class */
+					$related_model_obj = $this->_model_relations[$relationName];
+					//					if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relationName);
+					$related_model_obj->save_new_cached_related_model_objs();
+					//					}
+				} else {
+					foreach ($this->_model_relations[$relationName] as $related_model_obj) {
+						//add a relation to that relation type (which saves the appropriate thing in the process)
+						//but ONLY if it DOES NOT exist in the DB
+						//						if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relationName);
+						$related_model_obj->save_new_cached_related_model_objs();
+						//						}
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return \EEM_Base | \EEM_CPT_Base
+	 */
+	public function get_model()
+	{
+		$modelName = self::_get_model_classname(get_class($this));
+		return self::_get_model_instance_with_name($modelName, $this->_timezone);
+	}
+
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws \EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		//TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
+			$id = $props_n_values[$primary_id_ref];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param  array  $props_n_values   incoming array of properties and their values
+	 * @param  string $classname        the classname of the child class
+	 * @param null    $timezone
+	 * @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 mixed (EE_Base_Class|bool)
+	 * @throws \EE_Error
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
+	{
+		$existing = null;
+		if (self::_get_model($classname)->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[$primary_id_ref])
+			) {
+				$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+					$props_n_values[$primary_id_ref]
+				);
+			}
+		} elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
+			//no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			//set date formats if present before setting values
+			if ( ! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				//set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	protected static function _get_model($classname, $timezone = null)
+	{
+		//find model for this class
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"What were you thinking calling _get_model(%s)?? You need to specify the class name",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = null)
+	{
+		if (strpos($model_name, "EE_") === 0) {
+			$model_classname = str_replace("EE_", "EEM_", $model_name);
+		} else {
+			$model_classname = "EEM_" . $model_name;
+		}
+		return $model_classname;
+	}
+
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @throws EE_Error
+	 * @return string
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws \EE_Error
+	 */
+	public function ID()
+	{
+		//now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($this->get_model()->has_primary_key_field()) {
+			return $this->_fields[self::_get_primary_key_name(get_class($this))];
+		} else {
+			return $this->get_model()->get_index_primary_key_string($this->_fields);
+		}
+	}
+
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relationName                     eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @throws EE_Error
+	 * @return EE_Base_Class the object the relation was added to
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = array(),
+		$cache_id = null
+	) {
+		//if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $this->get_model()
+								->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$extra_join_model_fields_n_values);
+			//clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relationName, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		} else {
+			//this thing doesn't exist in the DB,  so just cache it
+			if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(sprintf(
+					__('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+						'event_espresso'),
+					$otherObjectModelObjectOrID,
+					get_class($this)
+				));
+			} else {
+				$otherObject = $otherObjectModelObjectOrID;
+			}
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			//fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				//its saved so assumed relations exist in the DB, so we can just
+				//clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
+			} else {
+				//it's not saved, so it caches relations like this
+				$otherObject->cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relationName
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
+	 *                created in the join table.
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws \EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()
+								->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$where_query);
+			$this->clear_cache($relationName, $otherObject);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function _remove_relations($relationName, $where_query_params = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
+			$this->clear_cache($relationName, null, true);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache($relationName, null, true);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
+	 * @throws \EE_Error
+	 *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
+	 *                             you want IDs
+	 */
+	public function get_many_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			//this exists in the DB, so get the related things from either the cache or the DB
+			//if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+			} else {
+				//did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relationName);
+				if ( ! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+					//if no query parameters were passed, then we got all the related model objects
+					//for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relationName, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			//this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relationName);
+		}
+		return $related_model_objects;
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   like EEM_Base::get_all's
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  like EEM_Base::get_all's
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key (which doesn't make much sense, so you should probably
+	 *                              change it)
+	 * @return int
+	 */
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class (not an array, a single object)
+	 * @throws \EE_Error
+	 */
+	public function get_first_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
+			//if they've provided some query parameters, don't bother trying to cache the result
+			//also make sure we're not caching the result of get_first_related
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
+			if ($query_params
+				|| ! $this->get_model()->related_settings_for($relationName)
+					 instanceof
+					 EE_Belongs_To_Relation
+			) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			} else {
+				//first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relationName);
+				if ( ! $cached_result) {
+					$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+					$this->cache($relationName, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			//this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
+			if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			}
+			//this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
+			if ( ! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relationName);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+
+	/**
+	 * Does a delete on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+			$this->clear_cache($relationName, null, true);
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+		}
+		$this->clear_cache($relationName, null, true);
+		return $count;
+	}
+
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param  string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[$field_name]);
+	}
+
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param  mixed (string|array) $properties properties to check
+	 * @throws EE_Error
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array)$properties as $property_name) {
+			//first make sure this property exists
+			if ( ! $this->_fields[$property_name]) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields = $this->get_model()->field_settings(false);
+		$properties = array();
+		//remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[$field_name] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
+	 * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
+	 * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EE_Answer.class.php');
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
+	 * echo $answer->my_callback('monkeys',100);
+	 * //will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if ( ! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						"event_espresso"
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @param string $previous_value
+	 * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 * @throws \EE_Error
+	 * NOTE: if the values haven't changed, returns 0
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if ( ! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		} else {
+			foreach ($existing_rows_like_that as $existing_row) {
+				$existing_row->save(array('EXM_value' => $meta_value));
+			}
+			return count($existing_rows_like_that);
+		}
+	}
+
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param string  $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				array(
+					array(
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					),
+				)
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			array(
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			)
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws \EE_Error
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null)
+	{
+		if ($single) {
+			$result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			} else {
+				return $default;
+			}
+		} else {
+			$results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($results) {
+				$values = array();
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[$result->ID()] = $result->value();
+					}
+				}
+				return $values;
+			} else {
+				return $default;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param boolean $one_of_each_key
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function all_extra_meta_array($one_of_each_key = true)
+	{
+		$return_array = array();
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if ( ! isset($return_array[$extra_meta_obj->key()])) {
+						$return_array[$extra_meta_obj->key()] = array();
+					}
+					$return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		//find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		} else {
+			$first_few_properties = $this->model_field_array();
+			$first_few_properties = array_slice($first_few_properties, 0, 3);
+			$name_parts = array();
+			foreach ($first_few_properties as $name => $value) {
+				$name_parts[] = "$name:$value";
+			}
+			return implode(",", $name_parts);
+		}
+	}
+
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function in_entity_map()
+	{
+		if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
+			//well, if we looked, did we find it in the entity map?
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			//absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $this->get_model()->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = array();
+		return array_keys(get_object_vars($this));
+	}
+
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
 
 
 

core/admin/EE_Admin_Page.core.php

Doc Comments +4 added lines, -4 removed lines

@@ -703,7 +703,7 @@ 
      * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
      *
      * @access protected
-     * @return void
+     * @return false|null
      */
     protected function _verify_routes()
     {
@@ -757,7 +757,7 @@ 
      * this method simply verifies a given route and makes sure its an actual route available for the loaded page
      *
      * @param  string $route the route name we're verifying
-     * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
+     * @return boolean  (bool|Exception)      we'll throw an exception if this isn't a valid route.
      */
     protected function _verify_route($route)
     {
@@ -3247,7 +3247,7 @@ 
 
 
     /**
-     * @return mixed
+     * @return string[]
      */
     public function default_espresso_metaboxes()
     {
@@ -3267,7 +3267,7 @@ 
 
 
     /**
-     * @return mixed
+     * @return string
      */
     public function wp_page_slug()
     {

Indentation +3299 added lines, -3299 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -28,2114 +28,2114 @@ 
 {
 
 
-    //set in _init_page_props()
-    public $page_slug;
+	//set in _init_page_props()
+	public $page_slug;
 
-    public $page_label;
+	public $page_label;
 
-    public $page_folder;
+	public $page_folder;
 
-    //set in define_page_props()
-    protected $_admin_base_url;
+	//set in define_page_props()
+	protected $_admin_base_url;
 
-    protected $_admin_base_path;
+	protected $_admin_base_path;
 
-    protected $_admin_page_title;
+	protected $_admin_page_title;
 
-    protected $_labels;
+	protected $_labels;
 
 
-    //set early within EE_Admin_Init
-    protected $_wp_page_slug;
+	//set early within EE_Admin_Init
+	protected $_wp_page_slug;
 
-    //navtabs
-    protected $_nav_tabs;
+	//navtabs
+	protected $_nav_tabs;
 
-    protected $_default_nav_tab_name;
+	protected $_default_nav_tab_name;
 
-    //helptourstops
-    protected $_help_tour = array();
+	//helptourstops
+	protected $_help_tour = array();
 
 
-    //template variables (used by templates)
-    protected $_template_path;
+	//template variables (used by templates)
+	protected $_template_path;
 
-    protected $_column_template_path;
+	protected $_column_template_path;
 
-    /**
-     * @var array $_template_args
-     */
-    protected $_template_args = array();
+	/**
+	 * @var array $_template_args
+	 */
+	protected $_template_args = array();
 
-    /**
-     * this will hold the list table object for a given view.
-     *
-     * @var EE_Admin_List_Table $_list_table_object
-     */
-    protected $_list_table_object;
+	/**
+	 * this will hold the list table object for a given view.
+	 *
+	 * @var EE_Admin_List_Table $_list_table_object
+	 */
+	protected $_list_table_object;
 
-    //bools
-    protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
+	//bools
+	protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
 
-    protected $_routing;
+	protected $_routing;
 
-    //list table args
-    protected $_view;
+	//list table args
+	protected $_view;
 
-    protected $_views;
+	protected $_views;
 
 
-    //action => method pairs used for routing incoming requests
-    protected $_page_routes;
+	//action => method pairs used for routing incoming requests
+	protected $_page_routes;
 
-    protected $_page_config;
+	protected $_page_config;
 
-    //the current page route and route config
-    protected $_route;
+	//the current page route and route config
+	protected $_route;
 
-    protected $_route_config;
+	protected $_route_config;
 
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     * @var array.
-     */
-    protected $_default_route_query_args;
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 * @var array.
+	 */
+	protected $_default_route_query_args;
 
-    //set via request page and action args.
-    protected $_current_page;
+	//set via request page and action args.
+	protected $_current_page;
 
-    protected $_current_view;
+	protected $_current_view;
 
-    protected $_current_page_view_url;
+	protected $_current_page_view_url;
 
-    //sanitized request action (and nonce)
-    /**
-     * @var string $_req_action
-     */
-    protected $_req_action;
+	//sanitized request action (and nonce)
+	/**
+	 * @var string $_req_action
+	 */
+	protected $_req_action;
 
-    /**
-     * @var string $_req_nonce
-     */
-    protected $_req_nonce;
+	/**
+	 * @var string $_req_nonce
+	 */
+	protected $_req_nonce;
 
-    //search related
-    protected $_search_btn_label;
+	//search related
+	protected $_search_btn_label;
 
-    protected $_search_box_callback;
+	protected $_search_box_callback;
 
-    /**
-     * WP Current Screen object
-     *
-     * @var WP_Screen
-     */
-    protected $_current_screen;
+	/**
+	 * WP Current Screen object
+	 *
+	 * @var WP_Screen
+	 */
+	protected $_current_screen;
 
-    //for holding EE_Admin_Hooks object when needed (set via set_hook_object())
-    protected $_hook_obj;
+	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
+	protected $_hook_obj;
 
-    //for holding incoming request data
-    protected $_req_data;
+	//for holding incoming request data
+	protected $_req_data;
 
-    // yes / no array for admin form fields
-    protected $_yes_no_values = array();
-
-    //some default things shared by all child classes
-    protected $_default_espresso_metaboxes;
-
-    /**
-     *    EE_Registry Object
-     *
-     * @var    EE_Registry
-     * @access    protected
-     */
-    protected $EE = null;
-
-
-
-    /**
-     * This is just a property that flags whether the given route is a caffeinated route or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
-            $this->_is_caf = true;
-        }
-        $this->_yes_no_values = array(
-                array('id' => true, 'text' => __('Yes', 'event_espresso')),
-                array('id' => false, 'text' => __('No', 'event_espresso')),
-        );
-        //set the _req_data property.
-        $this->_req_data = array_merge($_GET, $_POST);
-        //routing enabled?
-        $this->_routing = $routing;
-        //set initial page props (child method)
-        $this->_init_page_props();
-        //set global defaults
-        $this->_set_defaults();
-        //set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        //other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        //This just allows us to have extending classes do something specific
-        // before the parent constructor runs _page_setup().
-        if (method_exists($this, '_before_page_setup')) {
-            $this->_before_page_setup();
-        }
-        //set up page dependencies
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => __('label for add new button'),
-     *            'edit' => __('label for edit button'),
-     *            'delete' => __('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
-     * route. Here's the format
-     * $this->_page_routes = array(
-     *        'default' => array(
-     *            'func' => '_default_method_handling_route',
-     *            'args' => array('array','of','args'),
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
-     *        ),
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
-     *        )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_routes();
-
-
-
-    /**
-     * _set_page_config
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
-     * Format:
-     * $this->_page_config = array(
-     *        'default' => array(
-     *            'labels' => array(
-     *                'buttons' => array(
-     *                    'add' => __('label for adding item'),
-     *                    'edit' => __('label for editing item'),
-     *                    'delete' => __('label for deleting item')
-     *                ),
-     *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
-     *            'nav' => array(
-     *                'label' => __('Label for Tab', 'event_espresso').
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
-     *                'order' => 10, //required to indicate tab position.
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
-     *            this flag to make sure the necessary js gets enqueued on page load.
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
-     *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
-     *                'tab_id' => array(
-     *                    'title' => 'tab_title',
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
-     *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
-     *                    ),
-     *                'tab2_id' => array(
-     *                    'title' => 'tab2 title',
-     *                    'filename' => 'file_name_2'
-     *                    'callback' => 'callback_method_for_content',
-     *                 ),
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
-     *            'help_tour' => array(
-     *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
-     *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
-     *            ),
-     *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
-     *            'require_nonce' to FALSE
-     *            )
-     * )
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_page_config();
-
-
-
-
-
-    /** end sample help_tour methods **/
-    /**
-     * _add_screen_options
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_screen_options();
-
-
-
-    /**
-     * _add_feature_pointers
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     *
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_feature_pointers();
-
-
-
-    /**
-     * load_scripts_styles
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
-     * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function load_scripts_styles();
-
-
-
-    /**
-     * admin_init
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_init();
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
-     *
-     * @abstract
-     * @access public
-     * @return void
-     */
-    abstract public function admin_notices();
-
-
-
-    /**
-     * admin_footer_scripts
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access public
-     * @return void
-     */
-    abstract public function admin_footer_scripts();
-
-
-
-    /**
-     * admin_footer
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
-     *
-     * @access  public
-     * @return void
-     */
-    public function admin_footer()
-    {
-    }
-
-
-
-    /**
-     * _global_ajax_hooks
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    protected function _global_ajax_hooks()
-    {
-        //for lazy loading of metabox content
-        add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
-    }
-
-
-
-    public function ajax_metabox_content()
-    {
-        $contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
-        $url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
-        self::cached_rss_display($contentid, $url);
-        wp_die();
-    }
-
-
-
-    /**
-     * _page_setup
-     * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
-     *
-     * @final
-     * @access protected
-     * @return void
-     */
-    final protected function _page_setup()
-    {
-        //requires?
-        //admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
-        add_action('admin_init', array($this, 'admin_init_global'), 5);
-        //next verify if we need to load anything...
-        $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
-        $this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
-        global $ee_menu_slugs;
-        $ee_menu_slugs = (array)$ee_menu_slugs;
-        if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
-            return;
-        }
-        // becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
-        if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
-            $this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
-        }
-        // then set blank or -1 action values to 'default'
-        $this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
-        //if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
-        $this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        //however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
-        $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
-        $this->_current_view = $this->_req_action;
-        $this->_req_nonce = $this->_req_action . '_nonce';
-        $this->_define_page_props();
-        $this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
-        //default things
-        $this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
-        //set page configs
-        $this->_set_page_routes();
-        $this->_set_page_config();
-        //let's include any referrer data in our default_query_args for this route for "stickiness".
-        if (isset($this->_req_data['wp_referer'])) {
-            $this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
-        }
-        //for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
-        if (method_exists($this, '_extend_page_config')) {
-            $this->_extend_page_config();
-        }
-        //for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
-            $this->_extend_page_config_for_cpt();
-        }
-        //filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
-        $this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
-        //if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
-        }
-        //next route only if routing enabled
-        if ($this->_routing && ! defined('DOING_AJAX')) {
-            $this->_verify_routes();
-            //next let's just check user_access and kill if no access
-            $this->check_user_access();
-            if ($this->_is_UI_request) {
-                //admin_init stuff - global, all views for this page class, specific view
-                add_action('admin_init', array($this, 'admin_init'), 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
-                }
-            } else {
-                //hijack regular WP loading and route admin request immediately
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
-                $this->route_admin_request();
-            }
-        }
-    }
-
-
-
-    /**
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _do_other_page_hooks()
-    {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
-        foreach ($registered_pages as $page) {
-            //now let's setup the file name and class that should be present
-            $classname = str_replace('.class.php', '', $page);
-            //autoloaders should take care of loading file
-            if ( ! class_exists($classname)) {
-                $error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
-                $error_msg[] = $error_msg[0]
-                               . "\r\n"
-                               . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                'event_espresso'), $page, '<br />', '<strong>' . $classname . '</strong>');
-                throw new EE_Error(implode('||', $error_msg));
-            }
-            $a = new ReflectionClass($classname);
-            //notice we are passing the instance of this class to the hook object.
-            $hookobj[] = $a->newInstance($this);
-        }
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
-     *
-     * @access public
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //let's set the current_screen and screen options to override what WP set
-        $this->_current_screen = get_current_screen();
-        //load admin_notices - global, page class, and view specific
-        add_action('admin_notices', array($this, 'admin_notices_global'), 5);
-        add_action('admin_notices', array($this, 'admin_notices'), 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
-        }
-        //load network admin_notices - global, page class, and view specific
-        add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
-        }
-        //this will save any per_page screen options if they are present
-        $this->_set_per_page_screen_options();
-        //setup list table properties
-        $this->_set_list_table();
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
-        $this->_add_registered_meta_boxes();
-        $this->_add_screen_columns();
-        //add screen options - global, page child class, and view specific
-        $this->_add_global_screen_options();
-        $this->_add_screen_options();
-        if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
-        }
-        //add help tab(s) and tours- set via page_config and qtips.
-        $this->_add_help_tour();
-        $this->_add_help_tabs();
-        $this->_add_qtips();
-        //add feature_pointers - global, page child class, and view specific
-        $this->_add_feature_pointers();
-        $this->_add_global_feature_pointers();
-        if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
-        }
-        //enqueue scripts/styles - global, page class, and view specific
-        add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
-        add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
-        if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
-            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
-        }
-        add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
-        //admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
-        if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
-            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
-        }
-        //admin footer scripts
-        add_action('admin_footer', array($this, 'admin_footer_global'), 99);
-        add_action('admin_footer', array($this, 'admin_footer'), 100);
-        if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
-            add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
-        }
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
-        //targeted hook
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
-    }
-
-
-
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        $this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
-        $this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
-        $this->default_nav_tab_name = 'overview';
-        //init template args
-        $this->_template_args = array(
-                'admin_page_header'  => '',
-                'admin_page_content' => '',
-                'post_body_content'  => '',
-                'before_list_table'  => '',
-                'after_list_table'   => '',
-        );
-    }
-
-
-
-    /**
-     * route_admin_request
-     *
-     * @see    _route_admin_request()
-     * @access public
-     * @return void|exception error
-     */
-    public function route_admin_request()
-    {
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    public function set_wp_page_slug($wp_page_slug)
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-        //if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
-        if (is_network_admin()) {
-            $this->_wp_page_slug .= '-network';
-        }
-    }
-
-
-
-    /**
-     * _verify_routes
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _verify_routes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
-            return false;
-        }
-        $this->_route = false;
-        $func = false;
-        $args = array();
-        // check that the page_routes array is not empty
-        if (empty($this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        // and that the requested page route exists
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route = $this->_page_routes[$this->_req_action];
-            $this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        // and that a default route exists
-        if ( ! array_key_exists('default', $this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
-            throw new EE_Error($error_msg);
-        }
-        //first lets' catch if the UI request has EVER been set.
-        if ($this->_is_UI_request === null) {
-            //lets set if this is a UI request or not.
-            $this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
-            //wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
-        }
-        $this->_set_current_labels();
-    }
-
-
-
-    /**
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
-     *
-     * @param  string $route the route name we're verifying
-     * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
-     */
-    protected function _verify_route($route)
-    {
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            return true;
-        } else {
-            // user error msg
-            $error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
-            // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
-            throw new EE_Error($error_msg);
-        }
-    }
-
-
-
-    /**
-     * perform nonce verification
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
-     *
-     * @param  string $nonce     The nonce sent
-     * @param  string $nonce_ref The nonce reference string (name0)
-     * @return mixed (bool|die)
-     */
-    protected function _verify_nonce($nonce, $nonce_ref)
-    {
-        // verify nonce against expected value
-        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
-            // these are not the droids you are looking for !!!
-            $msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
-            if (WP_DEBUG) {
-                $msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
-            }
-            if ( ! defined('DOING_AJAX')) {
-                wp_die($msg);
-            } else {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                $this->_return_json();
-            }
-        }
-    }
-
-
-
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _route_admin_request()
-    {
-        if ( ! $this->_is_UI_request) {
-            $this->_verify_routes();
-        }
-        $nonce_check = isset($this->_route_config['require_nonce'])
-            ? $this->_route_config['require_nonce']
-            : true;
-        if ($this->_req_action !== 'default' && $nonce_check) {
-            // set nonce from post data
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce])
-                : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        //set the nav_tabs array but ONLY if this is  UI_request
-        if ($this->_is_UI_request) {
-            $this->_set_nav_tabs();
-        }
-        // grab callback function
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
-        // check if callback has args
-        $args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
-        $error_msg = '';
-        // action right before calling route
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
-        }
-        // right before calling the route, let's remove _wp_http_referer from the
-        // $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
-        $_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
-        if ( ! empty($func)) {
-            if (is_array($func)) {
-                list($class, $method) = $func;
-            } else if (strpos($func, '::') !== false) {
-                list($class, $method) = explode('::', $func);
-            } else {
-                $class = $this;
-                $method = $func;
-            }
-            if ( ! (is_object($class) && $class === $this)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page_object'] = $this;
-            }
-
-            if (
-                //is it a method on a class that doesn't work?
-                (
-                    (
-                        method_exists($class, $method)
-                        && call_user_func_array(array($class, $method), $args) === false
-                    )
-                    && (
-                        //is it a standalone function that doesn't work?
-                        function_exists($method)
-                        && call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
-                    )
-                )
-                || (
-                    //is it neither a class method NOR a standalone function?
-                    ! method_exists($class, $method)
-                    && ! function_exists($method)
-                )
-            ) {
-                // user error msg
-                $error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
-                // developer error msg
-                $error_msg .= '||';
-                $error_msg .= sprintf(
-                    __(
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
-                        'event_espresso'
-                    ),
-                    $method
-                );
-            }
-            if ( ! empty($error_msg)) {
-                throw new EE_Error($error_msg);
-            }
-        }
-        //if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
-        //now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
-        if ($this->_is_UI_request === false
-            && is_array($this->_route)
-            && ! empty($this->_route['headers_sent_route'])
-        ) {
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
-        }
-    }
-
-
-
-    /**
-     * This method just allows the resetting of page properties in the case where a no headers
-     * route redirects to a headers route in its route config.
-     *
-     * @since   4.3.0
-     * @param  string $new_route New (non header) route to redirect to.
-     * @return   void
-     */
-    protected function _reset_routing_properties($new_route)
-    {
-        $this->_is_UI_request = true;
-        //now we set the current route to whatever the headers_sent_route is set at
-        $this->_req_data['action'] = $new_route;
-        //rerun page setup
-        $this->_page_setup();
-    }
-
-
-
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *(internally just uses EEH_URL's function with the same name)
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
-     *                                        url in an associative array indexed by the key 'wp_referer';
-     *                                        Example usage:
-     *                                        If the current page is:
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
-     *                                        &action=default&event_id=20&month_range=March%202015
-     *                                        &_wpnonce=5467821
-     *                                        and you call:
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
-     *                                        array(
-     *                                        'action' => 'resend_something',
-     *                                        'page=>espresso_registrations'
-     *                                        ),
-     *                                        $some_url,
-     *                                        true
-     *                                        );
-     *                                        It will produce a url in this structure:
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
-     *                                        month_range]=March%202015
-     * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
-    {
-        //if there is a _wp_http_referer include the values from the request but only if sticky = true
-        if ($sticky) {
-            $request = $_REQUEST;
-            unset($request['_wp_http_referer']);
-            unset($request['wp_referer']);
-            foreach ($request as $key => $value) {
-                //do not add nonces
-                if (strpos($key, 'nonce') !== false) {
-                    continue;
-                }
-                $args['wp_referer[' . $key . ']'] = $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
-    }
-
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param  string $help_tab_id the id for the connected help tab
-     * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @uses EEH_Template::get_help_tab_link()
-     * @return string              generated link
-     */
-    protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
-    {
-        return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
-    }
-
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tabs()
-    {
-        $tour_buttons = '';
-        if (isset($this->_page_config[$this->_req_action])) {
-            $config = $this->_page_config[$this->_req_action];
-            //is there a help tour for the current route?  if there is let's setup the tour buttons
-            if (isset($this->_help_tour[$this->_req_action])) {
-                $tb = array();
-                $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
-                foreach ($this->_help_tour['tours'] as $tour) {
-                    //if this is the end tour then we don't need to setup a button
-                    if ($tour instanceof EE_Help_Tour_final_stop) {
-                        continue;
-                    }
-                    $tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
-                }
-                $tour_buttons .= implode('<br />', $tb);
-                $tour_buttons .= '</div></div>';
-            }
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
-            if (is_array($config) && isset($config['help_sidebar'])) {
-                //check that the callback given is valid
-                if ( ! method_exists($this, $config['help_sidebar'])) {
-                    throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
-                            'event_espresso'), $config['help_sidebar'], get_class($this)));
-                }
-                $content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
-                $content .= $tour_buttons; //add help tour buttons.
-                //do we have any help tours setup?  Cause if we do we want to add the buttons
-                $this->_current_screen->set_help_sidebar($content);
-            }
-            //if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
-            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
-                $this->_current_screen->set_help_sidebar($tour_buttons);
-            }
-            //handle if no help_tabs are set so the sidebar will still show for the help tour buttons
-            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
-                $_ht['id'] = $this->page_slug;
-                $_ht['title'] = __('Help Tours', 'event_espresso');
-                $_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
-                $this->_current_screen->add_help_tab($_ht);
-            }/**/
-            if ( ! isset($config['help_tabs'])) {
-                return;
-            } //no help tabs for this route
-            foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
-                //we're here so there ARE help tabs!
-                //make sure we've got what we need
-                if ( ! isset($cfg['title'])) {
-                    throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
-                }
-                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
-                    throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
-                            'event_espresso'));
-                }
-                //first priority goes to content.
-                if ( ! empty($cfg['content'])) {
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
-                    //second priority goes to filename
-                } else if ( ! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
-                    //it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
-                        EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
-                                'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    $template_args['admin_page_obj'] = $this;
-                    $content = EEH_Template::display_template($file_path, $template_args, true);
-                } else {
-                    $content = '';
-                }
-                //check if callback is valid
-                if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
-                    EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
-                            'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
-                    return;
-                }
-                //setup config array for help tab method
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
-                $_ht = array(
-                        'id'       => $id,
-                        'title'    => $cfg['title'],
-                        'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
-                        'content'  => $content,
-                );
-                $this->_current_screen->add_help_tab($_ht);
-            }
-        }
-    }
-
-
-
-    /**
-     * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
-     *
-     * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
-     * @access protected
-     * @return void
-     */
-    protected function _add_help_tour()
-    {
-        $tours = array();
-        $this->_help_tour = array();
-        //exit early if help tours are turned off globally
-        if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
-            return;
-        }
-        //loop through _page_config to find any help_tour defined
-        foreach ($this->_page_config as $route => $config) {
-            //we're only going to set things up for this route
-            if ($route !== $this->_req_action) {
-                continue;
-            }
-            if (isset($config['help_tour'])) {
-                foreach ($config['help_tour'] as $tour) {
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
-                    //let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if ( ! is_readable($file_path)) {
-                        EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
-                                $file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
-                        return;
-                    }
-                    require_once $file_path;
-                    if ( ! class_exists($tour)) {
-                        $error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
-                        $error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
-                                        'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
-                        throw new EE_Error(implode('||', $error_msg));
-                    }
-                    $a = new ReflectionClass($tour);
-                    $tour_obj = $a->newInstance($this->_is_caf);
-                    $tours[] = $tour_obj;
-                    $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
-                }
-                //let's inject the end tour stop element common to all pages... this will only get seen once per machine.
-                $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
-                $tours[] = $end_stop_tour;
-                $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
-            }
-        }
-        if ( ! empty($tours)) {
-            $this->_help_tour['tours'] = $tours;
-        }
-        //thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
-    }
-
-
-
-    /**
-     * This simply sets up any qtips that have been defined in the page config
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array)$this->_route_config['qtips'];
-            //load qtip loader
-            $path = array(
-                    $this->_get_dir() . '/qtips/',
-                    EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            );
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_nav_tabs()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $i = 0;
-        foreach ($this->_page_config as $slug => $config) {
-            if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
-                continue;
-            } //no nav tab for this config
-            //check for persistent flag
-            if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
-                continue;
-            } //nav tab is only to appear when route requested.
-            if ( ! $this->check_user_access($slug, true)) {
-                continue;
-            } //no nav tab becasue current user does not have access.
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[$slug] = array(
-                    'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
-                    'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
-                    'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
-                    'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
-            );
-            $i++;
-        }
-        //if $this->_nav_tabs is empty then lets set the default
-        if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[$this->default_nav_tab_name] = array(
-                    'url'       => $this->admin_base_url,
-                    'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
-                    'css_class' => 'nav-tab-active',
-                    'order'     => 10,
-            );
-        }
-        //now let's sort the tabs according to order
-        usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
-    }
-
-
-
-    /**
-     * _set_current_labels
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_current_labels()
-    {
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
-            foreach ($this->_route_config['labels'] as $label => $text) {
-                if (is_array($text)) {
-                    foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[$label][$sublabel] = $subtext;
-                    }
-                } else {
-                    $this->_labels[$label] = $text;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        verifies user access for this admin page
-     *
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
-     * @return        BOOL|wp_die()
-     */
-    public function check_user_access($route_to_check = '', $verify_only = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
-                ? $this->_page_routes[$route_to_check]['capability'] : null;
-        if (empty($capability) && empty($route_to_check)) {
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
-        } else {
-            $capability = empty($capability) ? 'manage_options' : $capability;
-        }
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
-        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
-            if ($verify_only) {
-                return false;
-            } else {
-                if ( is_user_logged_in() ) {
-                    wp_die(__('You do not have access to this route.', 'event_espresso'));
-                } else {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_init_global()
-    {
-    }
-
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @access public
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-        //if metaboxes are present we need to add the nonce field
-        if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
-     *
-     * @access  public
-     * @return  void
-     */
-    public function admin_footer_global()
-    {
-        //dialog container for dialog helper
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
-        $d_cont .= '<div class="ee-notices"></div>';
-        $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
-        $d_cont .= '</div>';
-        echo $d_cont;
-        //help tour stuff?
-        if (isset($this->_help_tour[$this->_req_action])) {
-            echo implode('<br />', $this->_help_tour[$this->_req_action]);
-        }
-        //current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
-    }
-
-
-
-    /**
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
-     * For child classes:
-     * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
-     * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
-     *    'help_trigger_id' => array(
-     *        'title' => __('localized title for popup', 'event_espresso'),
-     *        'content' => __('localized content for popup', 'event_espresso')
-     *    )
-     * );
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
-     *
-     * @access protected
-     * @return string content
-     */
-    protected function _set_help_popup_content($help_array = array(), $display = false)
-    {
-        $content = '';
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
-        //loop through the array and setup content
-        foreach ($help_array as $trigger => $help) {
-            //make sure the array is setup properly
-            if ( ! isset($help['title']) || ! isset($help['content'])) {
-                throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'));
-            }
-            //we're good so let'd setup the template vars and then assign parsed template content to our content.
-            $template_args = array(
-                    'help_popup_id'      => $trigger,
-                    'help_popup_title'   => $help['title'],
-                    'help_popup_content' => $help['content'],
-            );
-            $content .= EEH_Template::display_template($template_path, $template_args, true);
-        }
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * All this does is retrive the help content array if set by the EE_Admin_Page child
-     *
-     * @access private
-     * @return array properly formatted array for help popup content
-     */
-    private function _get_help_content()
-    {
-        //what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        //if method doesn't exist let's get out.
-        if ( ! method_exists($this, $method_name)) {
-            return array();
-        }
-        //k we're good to go let's retrieve the help array
-        $help_array = call_user_func(array($this, $method_name));
-        //make sure we've got an array!
-        if ( ! is_array($help_array)) {
-            throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
-        }
-        return $help_array;
-    }
-
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @access protected
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
-     * @param boolean $display    if false then we return the trigger string
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     */
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
-    {
-        if (defined('DOING_AJAX')) {
-            return;
-        }
-        //let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
-            $help_array[$trigger_id] = array(
-                    'title'   => __('Missing Content', 'event_espresso'),
-                    'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                            'event_espresso'),
-            );
-            $help_content = $this->_set_help_popup_content($help_array, false);
-        }
-        //let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content = $content . $help_content;
-        if ($display) {
-            echo $content;
-        } else {
-            return $content;
-        }
-    }
-
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @access private
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        /** STYLES **/
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', array($this, 'add_xdebug_style'));
-        }
-        // register all styles
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
-        //helpers styles
-        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
-        /** SCRIPTS **/
-        //register all scripts
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
-        add_filter('FHEE_load_joyride', '__return_true');
-        //script for sorting tables
-        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
-        //script for parsing uri's
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
-        //and parsing associative serialized form elements
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        //helpers scripts
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
-        //google charts
-        wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
-        // ENQUEUE ALL BASICS BY DEFAULT
-        wp_enqueue_style('ee-admin-css');
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-accounting');
-        wp_enqueue_script('jquery-validate');
-        //taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-        // LOCALIZED DATA
-        //localize script for ajax lazy loading
-        $lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
-        /**
-         * help tour stuff
-         */
-        if ( ! empty($this->_help_tour)) {
-            //register the js for kicking things off
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
-            //setup tours for the js tour object
-            foreach ($this->_help_tour['tours'] as $tour) {
-                $tours[] = array(
-                        'id'      => $tour->get_slug(),
-                        'options' => $tour->get_options(),
-                );
-            }
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
-            //admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
-        }
-    }
-
-
-
-    /**
-     *        admin_footer_scripts_eei18n_js_strings
-     *
-     * @access        public
-     * @return        void
-     */
-    public function admin_footer_scripts_eei18n_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
-        EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
-        EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
-        EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
-        EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
-        EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
-        EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
-        EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
-        EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
-        EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
-        EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
-        EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
-        EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
-    }
-
-
-
-    /**
-     *        load enhanced xdebug styles for ppl with failing eyesight
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_xdebug_style()
-    {
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
-    }
-
-
-    /************************/
-    /** LIST TABLE METHODS **/
-    /************************/
-    /**
-     * this sets up the list table if the current view requires it.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table()
-    {
-        //first is this a list_table view?
-        if ( ! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        //list table functions are per view specific (because some admin pages might have more than one listtable!)
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
-            //user error msg
-            $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
-            //developer error msg
-            $error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
-            throw new EE_Error($error_msg);
-        }
-        //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
-        $this->_set_list_table_view();
-        $this->_set_list_table_object();
-    }
-
-
-
-    /**
-     *        set current view for List Table
-     *
-     * @access public
-     * @return array
-     */
-    protected function _set_list_table_view()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // looking at active items or dumpster diving ?
-        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
-        } else {
-            $this->_view = sanitize_key($this->_req_data['status']);
-        }
-    }
-
-
-
-    /**
-     * _set_list_table_object
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_list_table_object()
-    {
-        if (isset($this->_route_config['list_table'])) {
-            if ( ! class_exists($this->_route_config['list_table'])) {
-                throw new EE_Error(
-                        sprintf(
-                                __(
-                                        'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
-                                        'event_espresso'
-                                ),
-                                $this->_route_config['list_table'],
-                                get_class($this)
-                        )
-                );
-            }
-            $list_table = $this->_route_config['list_table'];
-            $this->_list_table_object = new $list_table($this);
-        }
-    }
-
-
-
-    /**
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
-     *
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
-     *                                                    urls.  The array should be indexed by the view it is being
-     *                                                    added to.
-     * @return array
-     */
-    public function get_list_table_view_RLs($extra_query_args = array())
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (empty($this->_views)) {
-            $this->_views = array();
-        }
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = array();
-            // check for current view
-            $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
-            $query_args['action'] = $this->_req_action;
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-            $query_args['status'] = $view['slug'];
-            //merge any other arguments sent in.
-            if (isset($extra_query_args[$view['slug']])) {
-                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
-            }
-            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        }
-        return $this->_views;
-    }
-
-
-
-    /**
-     * _entries_per_page_dropdown
-     * generates a drop down box for selecting the number of visiable rows in an admin page list table
-     *
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
-     * @access protected
-     * @param int $max_entries total number of rows in the table
-     * @return string
-     */
-    protected function _entries_per_page_dropdown($max_entries = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $values = array(10, 25, 50, 100);
-        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+	// yes / no array for admin form fields
+	protected $_yes_no_values = array();
+
+	//some default things shared by all child classes
+	protected $_default_espresso_metaboxes;
+
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var    EE_Registry
+	 * @access    protected
+	 */
+	protected $EE = null;
+
+
+
+	/**
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
+			$this->_is_caf = true;
+		}
+		$this->_yes_no_values = array(
+				array('id' => true, 'text' => __('Yes', 'event_espresso')),
+				array('id' => false, 'text' => __('No', 'event_espresso')),
+		);
+		//set the _req_data property.
+		$this->_req_data = array_merge($_GET, $_POST);
+		//routing enabled?
+		$this->_routing = $routing;
+		//set initial page props (child method)
+		$this->_init_page_props();
+		//set global defaults
+		$this->_set_defaults();
+		//set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		//other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		//This just allows us to have extending classes do something specific
+		// before the parent constructor runs _page_setup().
+		if (method_exists($this, '_before_page_setup')) {
+			$this->_before_page_setup();
+		}
+		//set up page dependencies
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => __('label for add new button'),
+	 *            'edit' => __('label for edit button'),
+	 *            'delete' => __('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
+	 * route. Here's the format
+	 * $this->_page_routes = array(
+	 *        'default' => array(
+	 *            'func' => '_default_method_handling_route',
+	 *            'args' => array('array','of','args'),
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
+	 *        ),
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
+	 *        )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_routes();
+
+
+
+	/**
+	 * _set_page_config
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
+	 * Format:
+	 * $this->_page_config = array(
+	 *        'default' => array(
+	 *            'labels' => array(
+	 *                'buttons' => array(
+	 *                    'add' => __('label for adding item'),
+	 *                    'edit' => __('label for editing item'),
+	 *                    'delete' => __('label for deleting item')
+	 *                ),
+	 *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
+	 *            'nav' => array(
+	 *                'label' => __('Label for Tab', 'event_espresso').
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
+	 *                'order' => 10, //required to indicate tab position.
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
+	 *            this flag to make sure the necessary js gets enqueued on page load.
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
+	 *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
+	 *                'tab_id' => array(
+	 *                    'title' => 'tab_title',
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
+	 *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
+	 *                    ),
+	 *                'tab2_id' => array(
+	 *                    'title' => 'tab2 title',
+	 *                    'filename' => 'file_name_2'
+	 *                    'callback' => 'callback_method_for_content',
+	 *                 ),
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
+	 *            'help_tour' => array(
+	 *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
+	 *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
+	 *            ),
+	 *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
+	 *            'require_nonce' to FALSE
+	 *            )
+	 * )
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_page_config();
+
+
+
+
+
+	/** end sample help_tour methods **/
+	/**
+	 * _add_screen_options
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_screen_options();
+
+
+
+	/**
+	 * _add_feature_pointers
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 *
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_feature_pointers();
+
+
+
+	/**
+	 * load_scripts_styles
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
+	 * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function load_scripts_styles();
+
+
+
+	/**
+	 * admin_init
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_init();
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_notices();
+
+
+
+	/**
+	 * admin_footer_scripts
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	abstract public function admin_footer_scripts();
+
+
+
+	/**
+	 * admin_footer
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
+	 *
+	 * @access  public
+	 * @return void
+	 */
+	public function admin_footer()
+	{
+	}
+
+
+
+	/**
+	 * _global_ajax_hooks
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	protected function _global_ajax_hooks()
+	{
+		//for lazy loading of metabox content
+		add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
+	}
+
+
+
+	public function ajax_metabox_content()
+	{
+		$contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
+		$url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
+		self::cached_rss_display($contentid, $url);
+		wp_die();
+	}
+
+
+
+	/**
+	 * _page_setup
+	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
+	 *
+	 * @final
+	 * @access protected
+	 * @return void
+	 */
+	final protected function _page_setup()
+	{
+		//requires?
+		//admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
+		add_action('admin_init', array($this, 'admin_init_global'), 5);
+		//next verify if we need to load anything...
+		$this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
+		$this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
+		global $ee_menu_slugs;
+		$ee_menu_slugs = (array)$ee_menu_slugs;
+		if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
+			return;
+		}
+		// becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
+		if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
+			$this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
+		}
+		// then set blank or -1 action values to 'default'
+		$this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
+		//if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
+		$this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
+		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
+		$this->_current_view = $this->_req_action;
+		$this->_req_nonce = $this->_req_action . '_nonce';
+		$this->_define_page_props();
+		$this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
+		//default things
+		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
+		//set page configs
+		$this->_set_page_routes();
+		$this->_set_page_config();
+		//let's include any referrer data in our default_query_args for this route for "stickiness".
+		if (isset($this->_req_data['wp_referer'])) {
+			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
+		}
+		//for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
+		if (method_exists($this, '_extend_page_config')) {
+			$this->_extend_page_config();
+		}
+		//for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
+			$this->_extend_page_config_for_cpt();
+		}
+		//filter routes and page_config so addons can add their stuff. Filtering done per class
+		$this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
+		$this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
+		//if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+			add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
+		}
+		//next route only if routing enabled
+		if ($this->_routing && ! defined('DOING_AJAX')) {
+			$this->_verify_routes();
+			//next let's just check user_access and kill if no access
+			$this->check_user_access();
+			if ($this->_is_UI_request) {
+				//admin_init stuff - global, all views for this page class, specific view
+				add_action('admin_init', array($this, 'admin_init'), 10);
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
+					add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
+				}
+			} else {
+				//hijack regular WP loading and route admin request immediately
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
+				$this->route_admin_request();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _do_other_page_hooks()
+	{
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
+		foreach ($registered_pages as $page) {
+			//now let's setup the file name and class that should be present
+			$classname = str_replace('.class.php', '', $page);
+			//autoloaders should take care of loading file
+			if ( ! class_exists($classname)) {
+				$error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
+				$error_msg[] = $error_msg[0]
+							   . "\r\n"
+							   . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+								'event_espresso'), $page, '<br />', '<strong>' . $classname . '</strong>');
+				throw new EE_Error(implode('||', $error_msg));
+			}
+			$a = new ReflectionClass($classname);
+			//notice we are passing the instance of this class to the hook object.
+			$hookobj[] = $a->newInstance($this);
+		}
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * load_page_dependencies
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//let's set the current_screen and screen options to override what WP set
+		$this->_current_screen = get_current_screen();
+		//load admin_notices - global, page class, and view specific
+		add_action('admin_notices', array($this, 'admin_notices_global'), 5);
+		add_action('admin_notices', array($this, 'admin_notices'), 10);
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
+			add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
+		}
+		//load network admin_notices - global, page class, and view specific
+		add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
+			add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
+		}
+		//this will save any per_page screen options if they are present
+		$this->_set_per_page_screen_options();
+		//setup list table properties
+		$this->_set_list_table();
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
+		$this->_add_registered_meta_boxes();
+		$this->_add_screen_columns();
+		//add screen options - global, page child class, and view specific
+		$this->_add_global_screen_options();
+		$this->_add_screen_options();
+		if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
+		}
+		//add help tab(s) and tours- set via page_config and qtips.
+		$this->_add_help_tour();
+		$this->_add_help_tabs();
+		$this->_add_qtips();
+		//add feature_pointers - global, page child class, and view specific
+		$this->_add_feature_pointers();
+		$this->_add_global_feature_pointers();
+		if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
+			call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
+		}
+		//enqueue scripts/styles - global, page class, and view specific
+		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
+		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
+		if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
+			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
+		}
+		add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
+		//admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
+		if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
+			add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
+		}
+		//admin footer scripts
+		add_action('admin_footer', array($this, 'admin_footer_global'), 99);
+		add_action('admin_footer', array($this, 'admin_footer'), 100);
+		if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
+			add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
+		}
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
+		//targeted hook
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
+	}
+
+
+
+	/**
+	 * _set_defaults
+	 * This sets some global defaults for class properties.
+	 */
+	private function _set_defaults()
+	{
+		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
+		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
+		$this->default_nav_tab_name = 'overview';
+		//init template args
+		$this->_template_args = array(
+				'admin_page_header'  => '',
+				'admin_page_content' => '',
+				'post_body_content'  => '',
+				'before_list_table'  => '',
+				'after_list_table'   => '',
+		);
+	}
+
+
+
+	/**
+	 * route_admin_request
+	 *
+	 * @see    _route_admin_request()
+	 * @access public
+	 * @return void|exception error
+	 */
+	public function route_admin_request()
+	{
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	public function set_wp_page_slug($wp_page_slug)
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
+		if (is_network_admin()) {
+			$this->_wp_page_slug .= '-network';
+		}
+	}
+
+
+
+	/**
+	 * _verify_routes
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _verify_routes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
+			return false;
+		}
+		$this->_route = false;
+		$func = false;
+		$args = array();
+		// check that the page_routes array is not empty
+		if (empty($this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		// and that the requested page route exists
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			$this->_route = $this->_page_routes[$this->_req_action];
+			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		// and that a default route exists
+		if ( ! array_key_exists('default', $this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
+			throw new EE_Error($error_msg);
+		}
+		//first lets' catch if the UI request has EVER been set.
+		if ($this->_is_UI_request === null) {
+			//lets set if this is a UI request or not.
+			$this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
+			//wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
+		}
+		$this->_set_current_labels();
+	}
+
+
+
+	/**
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
+	 *
+	 * @param  string $route the route name we're verifying
+	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
+	 */
+	protected function _verify_route($route)
+	{
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			return true;
+		} else {
+			// user error msg
+			$error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
+			// developer error msg
+			$error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
+			throw new EE_Error($error_msg);
+		}
+	}
+
+
+
+	/**
+	 * perform nonce verification
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
+	 *
+	 * @param  string $nonce     The nonce sent
+	 * @param  string $nonce_ref The nonce reference string (name0)
+	 * @return mixed (bool|die)
+	 */
+	protected function _verify_nonce($nonce, $nonce_ref)
+	{
+		// verify nonce against expected value
+		if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
+			// these are not the droids you are looking for !!!
+			$msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
+			if (WP_DEBUG) {
+				$msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
+			}
+			if ( ! defined('DOING_AJAX')) {
+				wp_die($msg);
+			} else {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				$this->_return_json();
+			}
+		}
+	}
+
+
+
+	/**
+	 * _route_admin_request()
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _route_admin_request()
+	{
+		if ( ! $this->_is_UI_request) {
+			$this->_verify_routes();
+		}
+		$nonce_check = isset($this->_route_config['require_nonce'])
+			? $this->_route_config['require_nonce']
+			: true;
+		if ($this->_req_action !== 'default' && $nonce_check) {
+			// set nonce from post data
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce])
+				: '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		//set the nav_tabs array but ONLY if this is  UI_request
+		if ($this->_is_UI_request) {
+			$this->_set_nav_tabs();
+		}
+		// grab callback function
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
+		// check if callback has args
+		$args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
+		$error_msg = '';
+		// action right before calling route
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
+		if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
+		}
+		// right before calling the route, let's remove _wp_http_referer from the
+		// $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
+		$_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
+		if ( ! empty($func)) {
+			if (is_array($func)) {
+				list($class, $method) = $func;
+			} else if (strpos($func, '::') !== false) {
+				list($class, $method) = explode('::', $func);
+			} else {
+				$class = $this;
+				$method = $func;
+			}
+			if ( ! (is_object($class) && $class === $this)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page_object'] = $this;
+			}
+
+			if (
+				//is it a method on a class that doesn't work?
+				(
+					(
+						method_exists($class, $method)
+						&& call_user_func_array(array($class, $method), $args) === false
+					)
+					&& (
+						//is it a standalone function that doesn't work?
+						function_exists($method)
+						&& call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
+					)
+				)
+				|| (
+					//is it neither a class method NOR a standalone function?
+					! method_exists($class, $method)
+					&& ! function_exists($method)
+				)
+			) {
+				// user error msg
+				$error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
+				// developer error msg
+				$error_msg .= '||';
+				$error_msg .= sprintf(
+					__(
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
+						'event_espresso'
+					),
+					$method
+				);
+			}
+			if ( ! empty($error_msg)) {
+				throw new EE_Error($error_msg);
+			}
+		}
+		//if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
+		//now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
+		if ($this->_is_UI_request === false
+			&& is_array($this->_route)
+			&& ! empty($this->_route['headers_sent_route'])
+		) {
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
+		}
+	}
+
+
+
+	/**
+	 * This method just allows the resetting of page properties in the case where a no headers
+	 * route redirects to a headers route in its route config.
+	 *
+	 * @since   4.3.0
+	 * @param  string $new_route New (non header) route to redirect to.
+	 * @return   void
+	 */
+	protected function _reset_routing_properties($new_route)
+	{
+		$this->_is_UI_request = true;
+		//now we set the current route to whatever the headers_sent_route is set at
+		$this->_req_data['action'] = $new_route;
+		//rerun page setup
+		$this->_page_setup();
+	}
+
+
+
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *(internally just uses EEH_URL's function with the same name)
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
+	 *                                        url in an associative array indexed by the key 'wp_referer';
+	 *                                        Example usage:
+	 *                                        If the current page is:
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
+	 *                                        &action=default&event_id=20&month_range=March%202015
+	 *                                        &_wpnonce=5467821
+	 *                                        and you call:
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
+	 *                                        array(
+	 *                                        'action' => 'resend_something',
+	 *                                        'page=>espresso_registrations'
+	 *                                        ),
+	 *                                        $some_url,
+	 *                                        true
+	 *                                        );
+	 *                                        It will produce a url in this structure:
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
+	 *                                        month_range]=March%202015
+	 * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
+	{
+		//if there is a _wp_http_referer include the values from the request but only if sticky = true
+		if ($sticky) {
+			$request = $_REQUEST;
+			unset($request['_wp_http_referer']);
+			unset($request['wp_referer']);
+			foreach ($request as $key => $value) {
+				//do not add nonces
+				if (strpos($key, 'nonce') !== false) {
+					continue;
+				}
+				$args['wp_referer[' . $key . ']'] = $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
+	}
+
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param  string $help_tab_id the id for the connected help tab
+	 * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @uses EEH_Template::get_help_tab_link()
+	 * @return string              generated link
+	 */
+	protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
+	{
+		return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
+	}
+
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tabs()
+	{
+		$tour_buttons = '';
+		if (isset($this->_page_config[$this->_req_action])) {
+			$config = $this->_page_config[$this->_req_action];
+			//is there a help tour for the current route?  if there is let's setup the tour buttons
+			if (isset($this->_help_tour[$this->_req_action])) {
+				$tb = array();
+				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
+				foreach ($this->_help_tour['tours'] as $tour) {
+					//if this is the end tour then we don't need to setup a button
+					if ($tour instanceof EE_Help_Tour_final_stop) {
+						continue;
+					}
+					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
+				}
+				$tour_buttons .= implode('<br />', $tb);
+				$tour_buttons .= '</div></div>';
+			}
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
+			if (is_array($config) && isset($config['help_sidebar'])) {
+				//check that the callback given is valid
+				if ( ! method_exists($this, $config['help_sidebar'])) {
+					throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
+							'event_espresso'), $config['help_sidebar'], get_class($this)));
+				}
+				$content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
+				$content .= $tour_buttons; //add help tour buttons.
+				//do we have any help tours setup?  Cause if we do we want to add the buttons
+				$this->_current_screen->set_help_sidebar($content);
+			}
+			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
+			if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
+				$this->_current_screen->set_help_sidebar($tour_buttons);
+			}
+			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
+			if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
+				$_ht['id'] = $this->page_slug;
+				$_ht['title'] = __('Help Tours', 'event_espresso');
+				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
+				$this->_current_screen->add_help_tab($_ht);
+			}/**/
+			if ( ! isset($config['help_tabs'])) {
+				return;
+			} //no help tabs for this route
+			foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
+				//we're here so there ARE help tabs!
+				//make sure we've got what we need
+				if ( ! isset($cfg['title'])) {
+					throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
+				}
+				if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+					throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
+							'event_espresso'));
+				}
+				//first priority goes to content.
+				if ( ! empty($cfg['content'])) {
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
+					//second priority goes to filename
+				} else if ( ! empty($cfg['filename'])) {
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+					//it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
+						EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
+								'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					$template_args['admin_page_obj'] = $this;
+					$content = EEH_Template::display_template($file_path, $template_args, true);
+				} else {
+					$content = '';
+				}
+				//check if callback is valid
+				if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
+					EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
+							'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
+					return;
+				}
+				//setup config array for help tab method
+				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+				$_ht = array(
+						'id'       => $id,
+						'title'    => $cfg['title'],
+						'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
+						'content'  => $content,
+				);
+				$this->_current_screen->add_help_tab($_ht);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
+	 *
+	 * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_help_tour()
+	{
+		$tours = array();
+		$this->_help_tour = array();
+		//exit early if help tours are turned off globally
+		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
+			return;
+		}
+		//loop through _page_config to find any help_tour defined
+		foreach ($this->_page_config as $route => $config) {
+			//we're only going to set things up for this route
+			if ($route !== $this->_req_action) {
+				continue;
+			}
+			if (isset($config['help_tour'])) {
+				foreach ($config['help_tour'] as $tour) {
+					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
+					//let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if ( ! is_readable($file_path)) {
+						EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
+								$file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
+						return;
+					}
+					require_once $file_path;
+					if ( ! class_exists($tour)) {
+						$error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
+						$error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
+										'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
+						throw new EE_Error(implode('||', $error_msg));
+					}
+					$a = new ReflectionClass($tour);
+					$tour_obj = $a->newInstance($this->_is_caf);
+					$tours[] = $tour_obj;
+					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
+				}
+				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
+				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
+				$tours[] = $end_stop_tour;
+				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
+			}
+		}
+		if ( ! empty($tours)) {
+			$this->_help_tour['tours'] = $tours;
+		}
+		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
+	}
+
+
+
+	/**
+	 * This simply sets up any qtips that have been defined in the page config
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array)$this->_route_config['qtips'];
+			//load qtip loader
+			$path = array(
+					$this->_get_dir() . '/qtips/',
+					EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			);
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_nav_tabs()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$i = 0;
+		foreach ($this->_page_config as $slug => $config) {
+			if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
+				continue;
+			} //no nav tab for this config
+			//check for persistent flag
+			if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
+				continue;
+			} //nav tab is only to appear when route requested.
+			if ( ! $this->check_user_access($slug, true)) {
+				continue;
+			} //no nav tab becasue current user does not have access.
+			$css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+			$this->_nav_tabs[$slug] = array(
+					'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
+					'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
+					'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
+					'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
+			);
+			$i++;
+		}
+		//if $this->_nav_tabs is empty then lets set the default
+		if (empty($this->_nav_tabs)) {
+			$this->_nav_tabs[$this->default_nav_tab_name] = array(
+					'url'       => $this->admin_base_url,
+					'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
+					'css_class' => 'nav-tab-active',
+					'order'     => 10,
+			);
+		}
+		//now let's sort the tabs according to order
+		usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
+	}
+
+
+
+	/**
+	 * _set_current_labels
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_current_labels()
+	{
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
+			foreach ($this->_route_config['labels'] as $label => $text) {
+				if (is_array($text)) {
+					foreach ($text as $sublabel => $subtext) {
+						$this->_labels[$label][$sublabel] = $subtext;
+					}
+				} else {
+					$this->_labels[$label] = $text;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        verifies user access for this admin page
+	 *
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
+	 * @return        BOOL|wp_die()
+	 */
+	public function check_user_access($route_to_check = '', $verify_only = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
+		$capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
+				? $this->_page_routes[$route_to_check]['capability'] : null;
+		if (empty($capability) && empty($route_to_check)) {
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
+		} else {
+			$capability = empty($capability) ? 'manage_options' : $capability;
+		}
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
+		if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
+			if ($verify_only) {
+				return false;
+			} else {
+				if ( is_user_logged_in() ) {
+					wp_die(__('You do not have access to this route.', 'event_espresso'));
+				} else {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+	}
+
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+		//if metaboxes are present we need to add the nonce field
+		if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
+	 *
+	 * @access  public
+	 * @return  void
+	 */
+	public function admin_footer_global()
+	{
+		//dialog container for dialog helper
+		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
+		$d_cont .= '<div class="ee-notices"></div>';
+		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
+		$d_cont .= '</div>';
+		echo $d_cont;
+		//help tour stuff?
+		if (isset($this->_help_tour[$this->_req_action])) {
+			echo implode('<br />', $this->_help_tour[$this->_req_action]);
+		}
+		//current set timezone for timezone js
+		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
+	}
+
+
+
+	/**
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
+	 * For child classes:
+	 * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
+	 * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
+	 *    'help_trigger_id' => array(
+	 *        'title' => __('localized title for popup', 'event_espresso'),
+	 *        'content' => __('localized content for popup', 'event_espresso')
+	 *    )
+	 * );
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
+	 *
+	 * @access protected
+	 * @return string content
+	 */
+	protected function _set_help_popup_content($help_array = array(), $display = false)
+	{
+		$content = '';
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
+		//loop through the array and setup content
+		foreach ($help_array as $trigger => $help) {
+			//make sure the array is setup properly
+			if ( ! isset($help['title']) || ! isset($help['content'])) {
+				throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'));
+			}
+			//we're good so let'd setup the template vars and then assign parsed template content to our content.
+			$template_args = array(
+					'help_popup_id'      => $trigger,
+					'help_popup_title'   => $help['title'],
+					'help_popup_content' => $help['content'],
+			);
+			$content .= EEH_Template::display_template($template_path, $template_args, true);
+		}
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * All this does is retrive the help content array if set by the EE_Admin_Page child
+	 *
+	 * @access private
+	 * @return array properly formatted array for help popup content
+	 */
+	private function _get_help_content()
+	{
+		//what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		//if method doesn't exist let's get out.
+		if ( ! method_exists($this, $method_name)) {
+			return array();
+		}
+		//k we're good to go let's retrieve the help array
+		$help_array = call_user_func(array($this, $method_name));
+		//make sure we've got an array!
+		if ( ! is_array($help_array)) {
+			throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
+		}
+		return $help_array;
+	}
+
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @access protected
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
+	 * @param boolean $display    if false then we return the trigger string
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 */
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
+	{
+		if (defined('DOING_AJAX')) {
+			return;
+		}
+		//let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+			$help_array[$trigger_id] = array(
+					'title'   => __('Missing Content', 'event_espresso'),
+					'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+							'event_espresso'),
+			);
+			$help_content = $this->_set_help_popup_content($help_array, false);
+		}
+		//let's setup the trigger
+		$content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+		$content = $content . $help_content;
+		if ($display) {
+			echo $content;
+		} else {
+			return $content;
+		}
+	}
+
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @access private
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		/** STYLES **/
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', array($this, 'add_xdebug_style'));
+		}
+		// register all styles
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
+		//helpers styles
+		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
+		/** SCRIPTS **/
+		//register all scripts
+		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
+		add_filter('FHEE_load_joyride', '__return_true');
+		//script for sorting tables
+		wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+		//script for parsing uri's
+		wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
+		//and parsing associative serialized form elements
+		wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		//helpers scripts
+		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
+		//google charts
+		wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
+		// ENQUEUE ALL BASICS BY DEFAULT
+		wp_enqueue_style('ee-admin-css');
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-accounting');
+		wp_enqueue_script('jquery-validate');
+		//taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+		// LOCALIZED DATA
+		//localize script for ajax lazy loading
+		$lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
+		/**
+		 * help tour stuff
+		 */
+		if ( ! empty($this->_help_tour)) {
+			//register the js for kicking things off
+			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
+			//setup tours for the js tour object
+			foreach ($this->_help_tour['tours'] as $tour) {
+				$tours[] = array(
+						'id'      => $tour->get_slug(),
+						'options' => $tour->get_options(),
+				);
+			}
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
+			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
+		}
+	}
+
+
+
+	/**
+	 *        admin_footer_scripts_eei18n_js_strings
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function admin_footer_scripts_eei18n_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
+		EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
+		EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
+		EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
+		EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
+		EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
+		EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
+		EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
+		EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
+		EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
+		EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
+		EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
+		EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
+	}
+
+
+
+	/**
+	 *        load enhanced xdebug styles for ppl with failing eyesight
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_xdebug_style()
+	{
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
+	}
+
+
+	/************************/
+	/** LIST TABLE METHODS **/
+	/************************/
+	/**
+	 * this sets up the list table if the current view requires it.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table()
+	{
+		//first is this a list_table view?
+		if ( ! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		//list table functions are per view specific (because some admin pages might have more than one listtable!)
+		if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
+			//user error msg
+			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
+			//developer error msg
+			$error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
+							$this->_req_action, '_set_list_table_views_' . $this->_req_action);
+			throw new EE_Error($error_msg);
+		}
+		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
+		$this->_set_list_table_view();
+		$this->_set_list_table_object();
+	}
+
+
+
+	/**
+	 *        set current view for List Table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	protected function _set_list_table_view()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// looking at active items or dumpster diving ?
+		if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
+		} else {
+			$this->_view = sanitize_key($this->_req_data['status']);
+		}
+	}
+
+
+
+	/**
+	 * _set_list_table_object
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_list_table_object()
+	{
+		if (isset($this->_route_config['list_table'])) {
+			if ( ! class_exists($this->_route_config['list_table'])) {
+				throw new EE_Error(
+						sprintf(
+								__(
+										'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
+										'event_espresso'
+								),
+								$this->_route_config['list_table'],
+								get_class($this)
+						)
+				);
+			}
+			$list_table = $this->_route_config['list_table'];
+			$this->_list_table_object = new $list_table($this);
+		}
+	}
+
+
+
+	/**
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
+	 *
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
+	 *                                                    urls.  The array should be indexed by the view it is being
+	 *                                                    added to.
+	 * @return array
+	 */
+	public function get_list_table_view_RLs($extra_query_args = array())
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (empty($this->_views)) {
+			$this->_views = array();
+		}
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = array();
+			// check for current view
+			$this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
+			$query_args['action'] = $this->_req_action;
+			$query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+			$query_args['status'] = $view['slug'];
+			//merge any other arguments sent in.
+			if (isset($extra_query_args[$view['slug']])) {
+				$query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
+			}
+			$this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		}
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * _entries_per_page_dropdown
+	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
+	 *
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
+	 * @access protected
+	 * @param int $max_entries total number of rows in the table
+	 * @return string
+	 */
+	protected function _entries_per_page_dropdown($max_entries = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$values = array(10, 25, 50, 100);
+		$per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
+		if ($max_entries) {
+			$values[] = $max_entries;
+			sort($values);
+		}
+		$entries_per_page_dropdown = '
 			<div id="entries-per-page-dv" class="alignleft actions">
 				<label class="hide-if-no-js">
 					Show
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
-        foreach ($values as $value) {
-            if ($value < $max_entries) {
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
-                $entries_per_page_dropdown .= '
+		foreach ($values as $value) {
+			if ($value < $max_entries) {
+				$selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
+				$entries_per_page_dropdown .= '
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
-            }
-        }
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
-        $entries_per_page_dropdown .= '
+			}
+		}
+		$selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
+		$entries_per_page_dropdown .= '
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
-        $entries_per_page_dropdown .= '
+		$entries_per_page_dropdown .= '
 					</select>
 					entries
 				</label>
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
 			</div>
 		';
-        return $entries_per_page_dropdown;
-    }
-
-
-
-    /**
-     *        _set_search_attributes
-     *
-     * @access        protected
-     * @return        void
-     */
-    public function _set_search_attributes()
-    {
-        $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
-    }
-
-    /*** END LIST TABLE METHODS **/
-    /*****************************/
-    /**
-     *        _add_registered_metaboxes
-     *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
-     * @access private
-     * @return void
-     */
-    private function _add_registered_meta_boxes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //we only add meta boxes if the page_route calls for it
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
-            && is_array(
-                    $this->_route_config['metaboxes']
-            )
-        ) {
-            // this simply loops through the callbacks provided
-            // and checks if there is a corresponding callback registered by the child
-            // if there is then we go ahead and process the metabox loader.
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
-                } else {
-                    $result = call_user_func(array($this, &$metabox_callback));
-                }
-                if ($result === false) {
-                    // user error msg
-                    $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
-                    // developer error msg
-                    $error_msg .= '||' . sprintf(
-                                    __(
-                                            'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
-                                            'event_espresso'
-                                    ),
-                                    $metabox_callback
-                            );
-                    throw new EE_Error($error_msg);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * _add_screen_columns
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-                is_array($this->_route_config)
-                && isset($this->_route_config['columns'])
-                && is_array($this->_route_config['columns'])
-                && count($this->_route_config['columns']) === 2
-        ) {
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
-            $screen_id = $this->_current_screen->id;
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
-            $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
-            $this->_template_args['screen'] = $this->_current_screen;
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
-            //finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
-            $this->_route_config['has_metaboxes'] = true;
-        }
-    }
-
-
-
-    /**********************************/
-    /** GLOBALLY AVAILABLE METABOXES **/
-    /**
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
-     * loaded on.
-     */
-    private function _espresso_news_post_box()
-    {
-        $news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
-        add_meta_box('espresso_news_post_box', $news_box_title, array(
-                $this,
-                'espresso_news_post_box',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox.
-     */
-    protected function _espresso_ratings_request()
-    {
-        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
-            return '';
-        }
-        $ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
-        add_meta_box('espresso_ratings_request', $ratings_box_title, array(
-                $this,
-                'espresso_ratings_request',
-        ), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     */
-    public function espresso_ratings_request()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
-        EEH_Template::display_template($template_path, array());
-    }
-
-
-
-    public static function cached_rss_display($rss_id, $url)
-    {
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
-        $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
-        $post = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
-        if (false != ($output = get_transient($cache_key))) {
-            echo $pre . $output . $post;
-            return true;
-        }
-        if ( ! $doing_ajax) {
-            echo $pre . $loading . $post;
-            return false;
-        }
-        ob_start();
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
-        return true;
-    }
-
-
-
-    public function espresso_news_post_box()
-    {
-        ?>
+		return $entries_per_page_dropdown;
+	}
+
+
+
+	/**
+	 *        _set_search_attributes
+	 *
+	 * @access        protected
+	 * @return        void
+	 */
+	public function _set_search_attributes()
+	{
+		$this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
+	}
+
+	/*** END LIST TABLE METHODS **/
+	/*****************************/
+	/**
+	 *        _add_registered_metaboxes
+	 *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
+	 * @access private
+	 * @return void
+	 */
+	private function _add_registered_meta_boxes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//we only add meta boxes if the page_route calls for it
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
+			&& is_array(
+					$this->_route_config['metaboxes']
+			)
+		) {
+			// this simply loops through the callbacks provided
+			// and checks if there is a corresponding callback registered by the child
+			// if there is then we go ahead and process the metabox loader.
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
+				} else {
+					$result = call_user_func(array($this, &$metabox_callback));
+				}
+				if ($result === false) {
+					// user error msg
+					$error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
+					// developer error msg
+					$error_msg .= '||' . sprintf(
+									__(
+											'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
+											'event_espresso'
+									),
+									$metabox_callback
+							);
+					throw new EE_Error($error_msg);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * _add_screen_columns
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+				is_array($this->_route_config)
+				&& isset($this->_route_config['columns'])
+				&& is_array($this->_route_config['columns'])
+				&& count($this->_route_config['columns']) === 2
+		) {
+			add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
+			$screen_id = $this->_current_screen->id;
+			$screen_columns = (int)get_user_option("screen_layout_$screen_id");
+			$total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
+			$this->_template_args['screen'] = $this->_current_screen;
+			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
+			//finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
+			$this->_route_config['has_metaboxes'] = true;
+		}
+	}
+
+
+
+	/**********************************/
+	/** GLOBALLY AVAILABLE METABOXES **/
+	/**
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
+	 * loaded on.
+	 */
+	private function _espresso_news_post_box()
+	{
+		$news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
+		add_meta_box('espresso_news_post_box', $news_box_title, array(
+				$this,
+				'espresso_news_post_box',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox.
+	 */
+	protected function _espresso_ratings_request()
+	{
+		if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+			return '';
+		}
+		$ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
+		add_meta_box('espresso_ratings_request', $ratings_box_title, array(
+				$this,
+				'espresso_ratings_request',
+		), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 */
+	public function espresso_ratings_request()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
+		EEH_Template::display_template($template_path, array());
+	}
+
+
+
+	public static function cached_rss_display($rss_id, $url)
+	{
+		$loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
+		$doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
+		$post = '</div>' . "\n";
+		$cache_key = 'ee_rss_' . md5($rss_id);
+		if (false != ($output = get_transient($cache_key))) {
+			echo $pre . $output . $post;
+			return true;
+		}
+		if ( ! $doing_ajax) {
+			echo $pre . $loading . $post;
+			return false;
+		}
+		ob_start();
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
+		return true;
+	}
+
+
+
+	public function espresso_news_post_box()
+	{
+		?>
         <div class="padding">
             <div id="espresso_news_post_box_content" class="infolinks">
                 <?php
-                // Get RSS Feed(s)
-                $feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
-                $url = urlencode($feed_url);
-                self::cached_rss_display('espresso_news_post_box_content', $url);
-                ?>
+				// Get RSS Feed(s)
+				$feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
+				$url = urlencode($feed_url);
+				self::cached_rss_display('espresso_news_post_box_content', $url);
+				?>
             </div>
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
         </div>
         <?php
-    }
-
-
-
-    private function _espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-
-    public function espresso_links_post_box()
-    {
-        //Hiding until we actually have content to put in here...
-        //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
-        //EEH_Template::display_template( $templatepath );
-    }
-
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        $show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
-        if ($show_sponsors) {
-            add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
-        }
-    }
-
-
-
-    public function espresso_sponsors_post_box()
-    {
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
-        EEH_Template::display_template($templatepath);
-    }
-
-
-
-    private function _publish_post_box()
-    {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
-        //if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
-        } else {
-            $box_label = __('Publish', 'event_espresso');
-        }
-        $box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
-        add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
-    }
-
-
-
-    public function editor_overview()
-    {
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /** end of globally available metaboxes section **/
-    /*************************************************/
-    /**
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
-     * protected method.
-     *
-     * @see   $this->_set_publish_post_box_vars for param details
-     * @since 4.6.0
-     */
-    public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
-    {
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
-    }
-
-
-
-    /**
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
-     * Note: currently there is no validation for this.  However if you want the delete button, the
-     * save, and save and close buttons to work properly, then you will want to include a
-     * values for the name and id arguments.
-     *
-     * @todo  Add in validation for name/id arguments.
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
-     * @param    int     $id                      id attached to the item published
-     * @param    string  $delete                  page route callback for the delete action
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
-     * @throws \EE_Error
-     */
-    protected function _set_publish_post_box_vars(
-            $name = '',
-            $id = 0,
-            $delete = '',
-            $save_close_redirect_URL = '',
-            $both_btns = true
-    ) {
-        // if Save & Close, use a custom redirect URL or default to the main page?
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
-        // create the Save & Close and Save buttons
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
-        //if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        if ($delete && ! empty($id)) {
-            //make sure we have a default if just true is sent.
-            $delete = ! empty($delete) ? $delete : 'delete';
-            $delete_link_args = array($name => $id);
-            $delete = $this->get_action_link_or_button(
-                    $delete,
-                    $delete,
-                    $delete_link_args,
-                    'submitdelete deletion',
-                    '',
-                    false
-            );
-        }
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if ( ! empty($name) && ! empty($id)) {
-            $hidden_field_arr[$name] = array(
-                    'type'  => 'hidden',
-                    'value' => $id,
-            );
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
-        } else {
-            $hf = '';
-        }
-        // add hidden field
-        $this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
-    }
-
-
-
-    /**
-     *        displays an error message to ppl who have javascript disabled
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_no_javascript_warning()
-    {
-        ?>
+	}
+
+
+
+	private function _espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+
+	public function espresso_links_post_box()
+	{
+		//Hiding until we actually have content to put in here...
+		//$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
+		//EEH_Template::display_template( $templatepath );
+	}
+
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		$show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
+		if ($show_sponsors) {
+			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
+		}
+	}
+
+
+
+	public function espresso_sponsors_post_box()
+	{
+		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
+		EEH_Template::display_template($templatepath);
+	}
+
+
+
+	private function _publish_post_box()
+	{
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+		//if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
+		} else {
+			$box_label = __('Publish', 'event_espresso');
+		}
+		$box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
+		add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
+	}
+
+
+
+	public function editor_overview()
+	{
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/** end of globally available metaboxes section **/
+	/*************************************************/
+	/**
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
+	 * protected method.
+	 *
+	 * @see   $this->_set_publish_post_box_vars for param details
+	 * @since 4.6.0
+	 */
+	public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
+	{
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
+	}
+
+
+
+	/**
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
+	 * save, and save and close buttons to work properly, then you will want to include a
+	 * values for the name and id arguments.
+	 *
+	 * @todo  Add in validation for name/id arguments.
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
+	 * @param    int     $id                      id attached to the item published
+	 * @param    string  $delete                  page route callback for the delete action
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
+	 * @throws \EE_Error
+	 */
+	protected function _set_publish_post_box_vars(
+			$name = '',
+			$id = 0,
+			$delete = '',
+			$save_close_redirect_URL = '',
+			$both_btns = true
+	) {
+		// if Save & Close, use a custom redirect URL or default to the main page?
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
+		// create the Save & Close and Save buttons
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
+		//if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
+		if ($delete && ! empty($id)) {
+			//make sure we have a default if just true is sent.
+			$delete = ! empty($delete) ? $delete : 'delete';
+			$delete_link_args = array($name => $id);
+			$delete = $this->get_action_link_or_button(
+					$delete,
+					$delete,
+					$delete_link_args,
+					'submitdelete deletion',
+					'',
+					false
+			);
+		}
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
+		if ( ! empty($name) && ! empty($id)) {
+			$hidden_field_arr[$name] = array(
+					'type'  => 'hidden',
+					'value' => $id,
+			);
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+		} else {
+			$hf = '';
+		}
+		// add hidden field
+		$this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
+	}
+
+
+
+	/**
+	 *        displays an error message to ppl who have javascript disabled
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
         <noscript>
             <div id="no-js-message" class="error">
                 <p style="font-size:1.3em;">
@@ -2145,1267 +2145,1267 @@ 
             </div>
         </noscript>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        displays espresso success and/or error notices
-     *
-     * @access        private
-     * @return        string
-     */
-    private function _display_espresso_notices()
-    {
-        $notices = $this->_get_transient(true);
-        echo stripslashes($notices);
-    }
+	/**
+	 *        displays espresso success and/or error notices
+	 *
+	 * @access        private
+	 * @return        string
+	 */
+	private function _display_espresso_notices()
+	{
+		$notices = $this->_get_transient(true);
+		echo stripslashes($notices);
+	}
 
 
 
-    /**
-     *        spinny things pacify the masses
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	/**
+	 *        spinny things pacify the masses
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php esc_html_e('loading...', 'event_espresso'); ?></span>
         </div>
         <?php
-    }
+	}
 
 
 
-    /**
-     *        add admin page overlay for modal boxes
-     *
-     * @access private
-     * @return string
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 *        add admin page overlay for modal boxes
+	 *
+	 * @access private
+	 * @return string
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
         <div id="espresso-admin-page-overlay-dv" class=""></div>
         <?php
-    }
-
-
-
-    /**
-     * facade for add_meta_box
-     *
-     * @param string  $action        where the metabox get's displayed
-     * @param string  $title         Title of Metabox (output in metabox header)
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
-     * @param array   $callback_args an array of args supplied for the metabox
-     * @param string  $column        what metabox column
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
-     */
-    public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
-        //if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = array(
-                    'template_path' => $this->_template_path,
-                    'template_args' => $this->_template_args,
-            );
-        }
-        //if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func ? create_function('$post, $metabox',
-                'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
-    }
-
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @return [type] [description]
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
-        //the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @access private
-     * @param  boolean $sidebar true with sidebar, false without
-     * @param  boolean $about   use the about admin wrapper instead of the default.
-     * @return void
-     */
-    private function _display_admin_page($sidebar = false, $about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
-        // set current wp page slug - looks like: event-espresso_page_event_categories
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
-                ? 'poststuff'
-                : 'espresso-default-admin';
-        $template_path = $sidebar
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-        // the final template wrapper
-        $this->admin_page_wrapper($about);
-    }
-
-
-
-    /**
-     * This is used to display caf preview pages.
-     *
-     * @since 4.3.2
-     * @param string $utm_campaign_source what is the key used for google analytics link
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
-     * @return void
-     * @throws \EE_Error
-     */
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
-    {
-        //let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
-        $buy_now_url = add_query_arg(
-                array(
-                        'ee_ver'       => 'ee4',
-                        'utm_source'   => 'ee4_plugin_admin',
-                        'utm_medium'   => 'link',
-                        'utm_campaign' => $utm_campaign_source,
-                        'utm_content'  => 'buy_now_button',
-                ),
-                'http://eventespresso.com/pricing/'
-        );
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
-                ? $this->get_action_link_or_button(
-                        '',
-                        'buy_now',
-                        array(),
-                        'button-primary button-large',
-                        $buy_now_url,
-                        true
-                )
-                : $this->_template_args['preview_action_button'];
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @access public
-     * @return void
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @access private
-     * @param boolean $sidebar whether to display with sidebar or not.
-     * @return void
-     */
-    private function _display_admin_list_table_page($sidebar = false)
-    {
-        //setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
-                ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
-                : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
-        $this->_template_args['list_table'] = $this->_list_table_object;
-        $this->_template_args['current_route'] = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
-        if ( ! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                    $ajax_sorting_callback . '_nonce',
-                    $ajax_sorting_callback . '_nonce',
-                    false,
-                    false
-            );
-            //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
-            //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
-        $nonce_ref = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
-        //display message about search results?
-        $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
-                ? '<p class="ee-search-results">' . sprintf(
-                        esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
-                        trim($this->_req_data['s'], '%')
-                ) . '</p>'
-                : '';
-        // filter before_list_table template arg
-        $this->_template_args['before_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-            $this->_template_args['before_list_table'],
-            $this->page_slug,
-            $this->_req_data,
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['before_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
-                (array) $this->_template_args['before_list_table'],
-                $this->page_slug,
-                $this->_req_data,
-                $this->_req_action
-            )
-        );
-        // filter after_list_table template arg
-        $this->_template_args['after_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
-            $this->_template_args['after_list_table'],
-            $this->page_slug,
-            $this->_req_data,
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-                (array) $this->_template_args['after_list_table'],
-                $this->page_slug,
-                $this->_req_data,
-                $this->_req_action
-            )
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => __('localized description of item');
-     *        )
-     * );
-     *
-     * @param  array $items see above for format of array
-     * @return string        html string of legend
-     */
-    protected function _display_legend($items)
-    {
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
-        return EEH_Template::display_template($legend_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     *
-     * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
-     *                             The returned json object is created from an array in the following format:
-     *                             array(
-     *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *                             'success' => FALSE, //(default FALSE) - contains any special success message.
-     *                             'notices' => '', // - contains any EE_Error formatted notices
-     *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *                             'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
-     *                             specific template args that might be included in here)
-     *                             )
-     *                             The json object is populated by whatever is set in the $_template_args property.
-     * @return void
-     */
-    protected function _return_json($sticky_notices = false)
-    {
-        //make sure any EE_Error notices have been handled.
-        $this->_process_notices(array(), true, $sticky_notices);
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
-        unset($this->_template_args['data']);
-        $json = array(
-                'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
-                'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
-                'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
-                'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
-                'notices'   => EE_Error::get_notices(),
-                'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
-                'data'      => array_merge($data, array('template_args' => $this->_template_args)),
-                'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        );
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-
-        exit();
-    }
-
-
-
-    /**
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function return_json()
-    {
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
-        }
-    }
-
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     * @access   public
-     */
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
-    {
-        $this->_hook_obj = $hook_obj;
-    }
-
-
-
-    /**
-     *        generates  HTML wrapper with Tabbed nav for an admin page
-     *
-     * @access public
-     * @param  boolean $about whether to use the special about page wrapper or default.
-     * @return void
-     */
-    public function admin_page_wrapper($about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
-                isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
-        // load settings page wrapper template
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
-        //about page?
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
-        if (defined('DOING_AJAX')) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
-            $this->_return_json();
-        } else {
-            EEH_Template::display_template($template_path, $this->_template_args);
-        }
-    }
-
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     */
-    protected function _get_main_nav_tabs()
-    {
-        //let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
-    }
-
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @access public
-     * @param $a
-     * @param $b
-     * @return int
-     */
-    private function _sort_nav_tabs($a, $b)
-    {
-        if ($a['order'] == $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-
-    /**
-     *    generates HTML for the forms used on admin pages
-     *
-     * @access protected
-     * @param    array $input_vars - array of input field details
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
-     * @return string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
-    {
-        $content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
-        return $content;
-    }
-
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @access protected
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
-     */
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
-    {
-        //make sure $text and $actions are in an array
-        $text = (array)$text;
-        $actions = (array)$actions;
-        $referrer_url = empty($referrer) ? '' : $referrer;
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
-        $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
-        $default_names = array('save', 'save_and_close');
-        //add in a hidden index for the current page (so save and close redirects properly)
-        $this->_template_args['save_buttons'] = $referrer_url;
-        foreach ($button_text as $key => $button) {
-            $ref = $default_names[$key];
-            $id = $this->_current_view . '_' . $ref;
-            $name = ! empty($actions) ? $actions[$key] : $ref;
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
-            if ( ! $both) {
-                break;
-            }
-        }
-    }
-
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     */
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @access protected
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
-    {
-        if (empty($route)) {
-            $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
-        // add nonce
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = array(
-                'action' => array('type' => 'hidden', 'value' => $route),
-        );
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array)$form_fields as $field_name => $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
-     * @since 4.5.0
-     */
-    public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        $this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
-    }
-
-
-
-    /**
-     *    _redirect_after_action
-     *
-     * @param int    $success            - whether success was for two or more records, or just one, or none
-     * @param string $what               - what the action was performed on
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        //class name for actions/filters.
-        $classname = get_class($this);
-        //set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
-        $notices = EE_Error::get_notices(false);
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if ( ! $override_overwrite || ! empty($notices['errors'])) {
-            EE_Error::overwrite_success();
-        }
-        if ( ! empty($what) && ! empty($action_desc)) {
-            // how many records affected ? more than one record ? or just one ?
-            if ($success > 1 && empty($notices['errors'])) {
-                // set plural msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" have been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            } else if ($success == 1 && empty($notices['errors'])) {
-                // set singular msg
-                EE_Error::add_success(
-                        sprintf(
-                                __('The "%s" has been successfully %s.', 'event_espresso'),
-                                $what,
-                                $action_desc
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        }
-        // check that $query_args isn't something crazy
-        if ( ! is_array($query_args)) {
-            $query_args = array();
-        }
-        /**
-         * Allow injecting actions before the query_args are modified for possible different
-         * redirections on save and close actions
-         *
-         * @since 4.2.0
-         * @param array $query_args       The original query_args array coming into the
-         *                                method.
-         */
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
-        //calculate where we're going (if we have a "save and close" button pushed)
-        if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
-            // regenerate query args array from referrer URL
-            parse_str($parsed_url['query'], $query_args);
-            // correct page and action will be in the query args now
-            $redirect_url = admin_url('admin.php');
-        }
-        //merge any default query_args set in _default_route_query_args property
-        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
-            $args_to_merge = array();
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
-                //is there a wp_referer array in our _default_route_query_args property?
-                if ($query_param == 'wp_referer') {
-                    $query_value = (array)$query_value;
-                    foreach ($query_value as $reference => $value) {
-                        if (strpos($reference, 'nonce') !== false) {
-                            continue;
-                        }
-                        //finally we will override any arguments in the referer with
-                        //what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[$reference])) {
-                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
-                        } else {
-                            $args_to_merge[$reference] = urlencode($value);
-                        }
-                    }
-                    continue;
-                }
-                $args_to_merge[$query_param] = $query_value;
-            }
-            //now let's merge these arguments but override with what was specifically sent in to the
-            //redirect.
-            $query_args = array_merge($args_to_merge, $query_args);
-        }
-        $this->_process_notices($query_args);
-        // generate redirect url
-        // if redirecting to anything other than the main page, add a nonce
-        if (isset($query_args['action'])) {
-            // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-        }
-        //we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if (defined('DOING_AJAX')) {
-            $default_data = array(
-                    'close'        => true,
-                    'redirect_url' => $redirect_url,
-                    'where'        => 'main',
-                    'what'         => 'append',
-            );
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
-     * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
-     * @return void
-     */
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
-    {
-        //first let's set individual error properties if doing_ajax and the properties aren't already set.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $notices = EE_Error::get_notices(false);
-            if (empty($this->_template_args['success'])) {
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
-            }
-        }
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        //IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if ( ! defined('DOING_AJAX') || $sticky_notices) {
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
-            $this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
-        }
-    }
-
-
-
-    /**
-     * get_action_link_or_button
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
-     *
-     * @param string $action        use this to indicate which action the url is generated with.
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
-     * @param string $base_url      If this is not provided
-     *                              the _admin_base_url will be used as the default for the button base_url.
-     *                              Otherwise this value will be used.
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_action_link_or_button(
-            $action,
-            $type = 'add',
-            $extra_request = array(),
-            $class = 'button-primary',
-            $base_url = '',
-            $exclude_nonce = false
-    ) {
-        //first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no page route for given action for the button.  This action was given: %s',
-                                    'event_espresso'
-                            ),
-                            $action
-                    )
-            );
-        }
-        if ( ! isset($this->_labels['buttons'][$type])) {
-            throw new EE_Error(
-                    sprintf(
-                            __(
-                                    'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
-                                    'event_espresso'
-                            ),
-                            $type
-                    )
-            );
-        }
-        //finally check user access for this button.
-        $has_access = $this->check_user_access($action, true);
-        if ( ! $has_access) {
-            return '';
-        }
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
-        $query_args = array(
-                'action' => $action,
-        );
-        //merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if ( ! empty($extra_request)) {
-            $query_args = array_merge($extra_request, $query_args);
-        }
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
-    }
-
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args = array(
-                'label'   => $this->_admin_page_title,
-                'default' => 10,
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        );
-        //ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if ( ! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $_POST['wp_screen_options']['option'];
-            $value = $_POST['wp_screen_options']['value'];
-            if ($option != sanitize_key($option)) {
-                return;
-            }
-            $map_option = $option;
-            $option = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $value = (int)$value;
-                    if ($value < 1 || $value > 999) {
-                        return;
-                    }
-                    break;
-                default:
-                    $value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
-            exit;
-        }
-    }
-
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args($data)
-    {
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
-    }
-
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @access protected
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
-     * @return void
-     */
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
-    {
-        $user_id = get_current_user_id();
-        if ( ! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        //now let's set the string for what kind of transient we're setting
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = $notices ? array('notices' => $data) : $data;
-        //is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        if ($existing) {
-            $data = array_merge((array)$data, (array)$existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool $notices true we get notices transient. False we just return normal route transient
-     * @return mixed data
-     */
-    protected function _get_transient($notices = false, $route = false)
-    {
-        $user_id = get_current_user_id();
-        $route = ! $route ? $this->_req_action : $route;
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
-        $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
-        //delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
-     * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        //retrieve all existing transients
-        $query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * get_view
-     *
-     * @access public
-     * @return string content of _view property
-     */
-    public function get_view()
-    {
-        return $this->_view;
-    }
-
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-
-    /**
-     * get_current_page
-     *
-     * @access public
-     * @return string _current_page property value
-     */
-    public function get_current_page()
-    {
-        return $this->_current_page;
-    }
-
-
-
-    /**
-     * get_current_view
-     *
-     * @access public
-     * @return string _current_view property value
-     */
-    public function get_current_view()
-    {
-        return $this->_current_view;
-    }
-
-
-
-    /**
-     * get_current_screen
-     *
-     * @access public
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @access public
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url()
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data()
-    {
-        return $this->_req_data;
-    }
-
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action()
-    {
-        return $this->_req_action;
-    }
-
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf()
-    {
-        return $this->_is_caf;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function default_espresso_metaboxes()
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function admin_base_url()
-    {
-        return $this->_admin_base_url;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function wp_page_slug()
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @access    protected
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return boolean
-     */
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
-    {
-        //remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            $config->core->ee_ueip_has_notified = true;
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        } else {
-            EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values()
-    {
-        return $this->_yes_no_values;
-    }
-
-
-
-    protected function _get_dir()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        return dirname($reflector->getFileName());
-    }
-
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    //below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
-     * array.
-     *
-     * @return bool success/fail
-     */
-    protected function _process_resend_registration()
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
-        do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
-        return $this->_template_args['success'];
-    }
-
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @access protected
-     * @param \EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
-        return $this->_template_args['success'];
-    }
+	}
+
+
+
+	/**
+	 * facade for add_meta_box
+	 *
+	 * @param string  $action        where the metabox get's displayed
+	 * @param string  $title         Title of Metabox (output in metabox header)
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
+	 * @param array   $callback_args an array of args supplied for the metabox
+	 * @param string  $column        what metabox column
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
+	 */
+	public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
+		//if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
+		if (empty($callback_args) && $create_func) {
+			$callback_args = array(
+					'template_path' => $this->_template_path,
+					'template_args' => $this->_template_args,
+			);
+		}
+		//if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
+		$call_back_func = $create_func ? create_function('$post, $metabox',
+				'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
+		add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @return [type] [description]
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
+		//the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @access private
+	 * @param  boolean $sidebar true with sidebar, false without
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
+	 * @return void
+	 */
+	private function _display_admin_page($sidebar = false, $about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
+		// set current wp page slug - looks like: event-espresso_page_event_categories
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
+				? 'poststuff'
+				: 'espresso-default-admin';
+		$template_path = $sidebar
+				? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+				: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+		// the final template wrapper
+		$this->admin_page_wrapper($about);
+	}
+
+
+
+	/**
+	 * This is used to display caf preview pages.
+	 *
+	 * @since 4.3.2
+	 * @param string $utm_campaign_source what is the key used for google analytics link
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
+	{
+		//let's generate a default preview action button if there isn't one already present.
+		$this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
+		$buy_now_url = add_query_arg(
+				array(
+						'ee_ver'       => 'ee4',
+						'utm_source'   => 'ee4_plugin_admin',
+						'utm_medium'   => 'link',
+						'utm_campaign' => $utm_campaign_source,
+						'utm_content'  => 'buy_now_button',
+				),
+				'http://eventespresso.com/pricing/'
+		);
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
+				? $this->get_action_link_or_button(
+						'',
+						'buy_now',
+						array(),
+						'button-primary button-large',
+						$buy_now_url,
+						true
+				)
+				: $this->_template_args['preview_action_button'];
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @access private
+	 * @param boolean $sidebar whether to display with sidebar or not.
+	 * @return void
+	 */
+	private function _display_admin_list_table_page($sidebar = false)
+	{
+		//setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
+				? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
+				: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
+		$this->_template_args['list_table'] = $this->_list_table_object;
+		$this->_template_args['current_route'] = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
+		if ( ! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+					$ajax_sorting_callback . '_nonce',
+					$ajax_sorting_callback . '_nonce',
+					false,
+					false
+			);
+			//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
+			//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
+		$nonce_ref = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
+		//display message about search results?
+		$this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
+				? '<p class="ee-search-results">' . sprintf(
+						esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
+						trim($this->_req_data['s'], '%')
+				) . '</p>'
+				: '';
+		// filter before_list_table template arg
+		$this->_template_args['before_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+			$this->_template_args['before_list_table'],
+			$this->page_slug,
+			$this->_req_data,
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['before_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
+				(array) $this->_template_args['before_list_table'],
+				$this->page_slug,
+				$this->_req_data,
+				$this->_req_action
+			)
+		);
+		// filter after_list_table template arg
+		$this->_template_args['after_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
+			$this->_template_args['after_list_table'],
+			$this->page_slug,
+			$this->_req_data,
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['after_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+				(array) $this->_template_args['after_list_table'],
+				$this->page_slug,
+				$this->_req_data,
+				$this->_req_action
+			)
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => __('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param  array $items see above for format of array
+	 * @return string        html string of legend
+	 */
+	protected function _display_legend($items)
+	{
+		$this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
+		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
+		return EEH_Template::display_template($legend_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 *
+	 * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
+	 *                             The returned json object is created from an array in the following format:
+	 *                             array(
+	 *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *                             'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *                             'notices' => '', // - contains any EE_Error formatted notices
+	 *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *                             'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
+	 *                             specific template args that might be included in here)
+	 *                             )
+	 *                             The json object is populated by whatever is set in the $_template_args property.
+	 * @return void
+	 */
+	protected function _return_json($sticky_notices = false)
+	{
+		//make sure any EE_Error notices have been handled.
+		$this->_process_notices(array(), true, $sticky_notices);
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
+		unset($this->_template_args['data']);
+		$json = array(
+				'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
+				'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
+				'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
+				'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
+				'notices'   => EE_Error::get_notices(),
+				'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
+				'data'      => array_merge($data, array('template_args' => $this->_template_args)),
+				'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		);
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+
+		exit();
+	}
+
+
+
+	/**
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function return_json()
+	{
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
+		}
+	}
+
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 * @access   public
+	 */
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
+	{
+		$this->_hook_obj = $hook_obj;
+	}
+
+
+
+	/**
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
+	 *
+	 * @access public
+	 * @param  boolean $about whether to use the special about page wrapper or default.
+	 * @return void
+	 */
+	public function admin_page_wrapper($about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
+		$this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
+				isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
+		// load settings page wrapper template
+		$template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+		//about page?
+		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
+		if (defined('DOING_AJAX')) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
+			$this->_return_json();
+		} else {
+			EEH_Template::display_template($template_path, $this->_template_args);
+		}
+	}
+
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 */
+	protected function _get_main_nav_tabs()
+	{
+		//let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
+	}
+
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @access public
+	 * @param $a
+	 * @param $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs($a, $b)
+	{
+		if ($a['order'] == $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+
+	/**
+	 *    generates HTML for the forms used on admin pages
+	 *
+	 * @access protected
+	 * @param    array $input_vars - array of input field details
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
+	 * @return string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
+	{
+		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
+		return $content;
+	}
+
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @access protected
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
+	 */
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
+	{
+		//make sure $text and $actions are in an array
+		$text = (array)$text;
+		$actions = (array)$actions;
+		$referrer_url = empty($referrer) ? '' : $referrer;
+		$referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
+				: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
+		$button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
+		$default_names = array('save', 'save_and_close');
+		//add in a hidden index for the current page (so save and close redirects properly)
+		$this->_template_args['save_buttons'] = $referrer_url;
+		foreach ($button_text as $key => $button) {
+			$ref = $default_names[$key];
+			$id = $this->_current_view . '_' . $ref;
+			$name = ! empty($actions) ? $actions[$key] : $ref;
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
+			if ( ! $both) {
+				break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 */
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @access protected
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
+	{
+		if (empty($route)) {
+			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
+			$dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
+		// add nonce
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = array(
+				'action' => array('type' => 'hidden', 'value' => $route),
+		);
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array)$form_fields as $field_name => $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		$this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
+	}
+
+
+
+	/**
+	 *    _redirect_after_action
+	 *
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
+	 * @param string $what               - what the action was performed on
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		//class name for actions/filters.
+		$classname = get_class($this);
+		//set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
+		$notices = EE_Error::get_notices(false);
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
+		if ( ! $override_overwrite || ! empty($notices['errors'])) {
+			EE_Error::overwrite_success();
+		}
+		if ( ! empty($what) && ! empty($action_desc)) {
+			// how many records affected ? more than one record ? or just one ?
+			if ($success > 1 && empty($notices['errors'])) {
+				// set plural msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" have been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			} else if ($success == 1 && empty($notices['errors'])) {
+				// set singular msg
+				EE_Error::add_success(
+						sprintf(
+								__('The "%s" has been successfully %s.', 'event_espresso'),
+								$what,
+								$action_desc
+						),
+						__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		}
+		// check that $query_args isn't something crazy
+		if ( ! is_array($query_args)) {
+			$query_args = array();
+		}
+		/**
+		 * Allow injecting actions before the query_args are modified for possible different
+		 * redirections on save and close actions
+		 *
+		 * @since 4.2.0
+		 * @param array $query_args       The original query_args array coming into the
+		 *                                method.
+		 */
+		do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
+		//calculate where we're going (if we have a "save and close" button pushed)
+		if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
+			// regenerate query args array from referrer URL
+			parse_str($parsed_url['query'], $query_args);
+			// correct page and action will be in the query args now
+			$redirect_url = admin_url('admin.php');
+		}
+		//merge any default query_args set in _default_route_query_args property
+		if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+			$args_to_merge = array();
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
+				//is there a wp_referer array in our _default_route_query_args property?
+				if ($query_param == 'wp_referer') {
+					$query_value = (array)$query_value;
+					foreach ($query_value as $reference => $value) {
+						if (strpos($reference, 'nonce') !== false) {
+							continue;
+						}
+						//finally we will override any arguments in the referer with
+						//what might be set on the _default_route_query_args array.
+						if (isset($this->_default_route_query_args[$reference])) {
+							$args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
+						} else {
+							$args_to_merge[$reference] = urlencode($value);
+						}
+					}
+					continue;
+				}
+				$args_to_merge[$query_param] = $query_value;
+			}
+			//now let's merge these arguments but override with what was specifically sent in to the
+			//redirect.
+			$query_args = array_merge($args_to_merge, $query_args);
+		}
+		$this->_process_notices($query_args);
+		// generate redirect url
+		// if redirecting to anything other than the main page, add a nonce
+		if (isset($query_args['action'])) {
+			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+		}
+		//we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+		$redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if (defined('DOING_AJAX')) {
+			$default_data = array(
+					'close'        => true,
+					'redirect_url' => $redirect_url,
+					'where'        => 'main',
+					'what'         => 'append',
+			);
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
+	 * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
+	 * @return void
+	 */
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
+	{
+		//first let's set individual error properties if doing_ajax and the properties aren't already set.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$notices = EE_Error::get_notices(false);
+			if (empty($this->_template_args['success'])) {
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
+			}
+		}
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
+		if ( ! defined('DOING_AJAX') || $sticky_notices) {
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
+			$this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
+		}
+	}
+
+
+
+	/**
+	 * get_action_link_or_button
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
+	 *
+	 * @param string $action        use this to indicate which action the url is generated with.
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
+	 * @param string $base_url      If this is not provided
+	 *                              the _admin_base_url will be used as the default for the button base_url.
+	 *                              Otherwise this value will be used.
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_action_link_or_button(
+			$action,
+			$type = 'add',
+			$extra_request = array(),
+			$class = 'button-primary',
+			$base_url = '',
+			$exclude_nonce = false
+	) {
+		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
+		if (empty($base_url) && ! isset($this->_page_routes[$action])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no page route for given action for the button.  This action was given: %s',
+									'event_espresso'
+							),
+							$action
+					)
+			);
+		}
+		if ( ! isset($this->_labels['buttons'][$type])) {
+			throw new EE_Error(
+					sprintf(
+							__(
+									'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
+									'event_espresso'
+							),
+							$type
+					)
+			);
+		}
+		//finally check user access for this button.
+		$has_access = $this->check_user_access($action, true);
+		if ( ! $has_access) {
+			return '';
+		}
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
+		$query_args = array(
+				'action' => $action,
+		);
+		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
+		if ( ! empty($extra_request)) {
+			$query_args = array_merge($extra_request, $query_args);
+		}
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
+	}
+
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args = array(
+				'label'   => $this->_admin_page_title,
+				'default' => 10,
+				'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		);
+		//ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if ( ! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $_POST['wp_screen_options']['option'];
+			$value = $_POST['wp_screen_options']['value'];
+			if ($option != sanitize_key($option)) {
+				return;
+			}
+			$map_option = $option;
+			$option = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$value = (int)$value;
+					if ($value < 1 || $value > 999) {
+						return;
+					}
+					break;
+				default:
+					$value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
+			exit;
+		}
+	}
+
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args($data)
+	{
+		$this->_template_args = array_merge($this->_template_args, (array)$data);
+	}
+
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @access protected
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 */
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
+	{
+		$user_id = get_current_user_id();
+		if ( ! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		//now let's set the string for what kind of transient we're setting
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = $notices ? array('notices' => $data) : $data;
+		//is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		if ($existing) {
+			$data = array_merge((array)$data, (array)$existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool $notices true we get notices transient. False we just return normal route transient
+	 * @return mixed data
+	 */
+	protected function _get_transient($notices = false, $route = false)
+	{
+		$user_id = get_current_user_id();
+		$route = ! $route ? $this->_req_action : $route;
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+		$data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
+		//delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
+	 * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		//retrieve all existing transients
+		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * get_view
+	 *
+	 * @access public
+	 * @return string content of _view property
+	 */
+	public function get_view()
+	{
+		return $this->_view;
+	}
+
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @access public
+	 * @return string _current_page property value
+	 */
+	public function get_current_page()
+	{
+		return $this->_current_page;
+	}
+
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @access public
+	 * @return string _current_view property value
+	 */
+	public function get_current_view()
+	{
+		return $this->_current_view;
+	}
+
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @access public
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @access public
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url()
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data()
+	{
+		return $this->_req_data;
+	}
+
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action()
+	{
+		return $this->_req_action;
+	}
+
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf()
+	{
+		return $this->_is_caf;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function default_espresso_metaboxes()
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function admin_base_url()
+	{
+		return $this->_admin_base_url;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function wp_page_slug()
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @access    protected
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return boolean
+	 */
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
+	{
+		//remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			$config->core->ee_ueip_has_notified = true;
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		} else {
+			EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values()
+	{
+		return $this->_yes_no_values;
+	}
+
+
+
+	protected function _get_dir()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		return dirname($reflector->getFileName());
+	}
+
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
+	 * array.
+	 *
+	 * @return bool success/fail
+	 */
+	protected function _process_resend_registration()
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
+		do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
+		return $this->_template_args['success'];
+	}
+
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @access protected
+	 * @param \EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
+		return $this->_template_args['success'];
+	}
 
 
 }

Spacing +144 added lines, -144 removed lines

@@ -474,7 +474,7 @@ 
         $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
         $this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
         global $ee_menu_slugs;
-        $ee_menu_slugs = (array)$ee_menu_slugs;
+        $ee_menu_slugs = (array) $ee_menu_slugs;
         if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
             return;
         }
@@ -489,7 +489,7 @@ 
         //however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
         $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce = $this->_req_action . '_nonce';
+        $this->_req_nonce = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
         //default things
@@ -510,11 +510,11 @@ 
             $this->_extend_page_config_for_cpt();
         }
         //filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
-        $this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
+        $this->_page_routes = apply_filters('FHEE__'.get_class($this).'__page_setup__page_routes', $this->_page_routes, $this);
+        $this->_page_config = apply_filters('FHEE__'.get_class($this).'__page_setup__page_config', $this->_page_config, $this);
         //if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
+            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view), 10, 2);
         }
         //next route only if routing enabled
         if ($this->_routing && ! defined('DOING_AJAX')) {
@@ -524,8 +524,8 @@ 
             if ($this->_is_UI_request) {
                 //admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', array($this, 'admin_init'), 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', array($this, 'admin_init_'.$this->_current_view), 15);
                 }
             } else {
                 //hijack regular WP loading and route admin request immediately
@@ -545,17 +545,17 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, array());
         foreach ($registered_pages as $page) {
             //now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             //autoloaders should take care of loading file
             if ( ! class_exists($classname)) {
-                $error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
+                $error_msg[] = sprintf(esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
                 $error_msg[] = $error_msg[0]
                                . "\r\n"
-                               . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                'event_espresso'), $page, '<br />', '<strong>' . $classname . '</strong>');
+                               . sprintf(esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+                                'event_espresso'), $page, '<br />', '<strong>'.$classname.'</strong>');
                 throw new EE_Error(implode('||', $error_msg));
             }
             $a = new ReflectionClass($classname);
@@ -591,13 +591,13 @@ 
         //load admin_notices - global, page class, and view specific
         add_action('admin_notices', array($this, 'admin_notices_global'), 5);
         add_action('admin_notices', array($this, 'admin_notices'), 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', array($this, 'admin_notices_'.$this->_current_view), 15);
         }
         //load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', array($this, 'network_admin_notices_'.$this->_current_view));
         }
         //this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -609,8 +609,8 @@ 
         //add screen options - global, page child class, and view specific
         $this->_add_global_screen_options();
         $this->_add_screen_options();
-        if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
+        if (method_exists($this, '_add_screen_options_'.$this->_current_view)) {
+            call_user_func(array($this, '_add_screen_options_'.$this->_current_view));
         }
         //add help tab(s) and tours- set via page_config and qtips.
         $this->_add_help_tour();
@@ -619,31 +619,31 @@ 
         //add feature_pointers - global, page child class, and view specific
         $this->_add_feature_pointers();
         $this->_add_global_feature_pointers();
-        if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
-            call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
+        if (method_exists($this, '_add_feature_pointer_'.$this->_current_view)) {
+            call_user_func(array($this, '_add_feature_pointer_'.$this->_current_view));
         }
         //enqueue scripts/styles - global, page class, and view specific
         add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
         add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
-        if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
-            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
+        if (method_exists($this, 'load_scripts_styles_'.$this->_current_view)) {
+            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_'.$this->_current_view), 15);
         }
         add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
         //admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
         add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
         add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
-        if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
-            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
+        if (method_exists($this, 'admin_footer_scripts_'.$this->_current_view)) {
+            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_'.$this->_current_view), 101);
         }
         //admin footer scripts
         add_action('admin_footer', array($this, 'admin_footer_global'), 99);
         add_action('admin_footer', array($this, 'admin_footer'), 100);
-        if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
-            add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
+        if (method_exists($this, 'admin_footer_'.$this->_current_view)) {
+            add_action('admin_footer', array($this, 'admin_footer_'.$this->_current_view), 101);
         }
         do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
         //targeted hook
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
+        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__'.$this->page_slug.'__'.$this->_req_action);
     }
 
 
@@ -719,7 +719,7 @@ 
             // user error msg
             $error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
             // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
+            $error_msg .= '||'.$error_msg.__(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
             throw new EE_Error($error_msg);
         }
         // and that the requested page route exists
@@ -730,7 +730,7 @@ 
             // user error msg
             $error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
             // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
+            $error_msg .= '||'.$error_msg.sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
@@ -738,7 +738,7 @@ 
             // user error msg
             $error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
             // developer error msg
-            $error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
+            $error_msg .= '||'.$error_msg.__(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
             throw new EE_Error($error_msg);
         }
         //first lets' catch if the UI request has EVER been set.
@@ -767,7 +767,7 @@ 
             // user error msg
             $error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
             // developer error msg
-            $error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
+            $error_msg .= '||'.$error_msg.sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
             throw new EE_Error($error_msg);
         }
     }
@@ -789,7 +789,7 @@ 
             // these are not the droids you are looking for !!!
             $msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
             if (WP_DEBUG) {
-                $msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
+                $msg .= "\n  ".sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
             }
             if ( ! defined('DOING_AJAX')) {
                 wp_die($msg);
@@ -967,7 +967,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args['wp_referer[' . $key . ']'] = $value;
+                $args['wp_referer['.$key.']'] = $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1013,7 +1013,7 @@ 
                     if ($tour instanceof EE_Help_Tour_final_stop) {
                         continue;
                     }
-                    $tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
+                    $tb[] = '<button id="trigger-tour-'.$tour->get_slug().'" class="button-primary trigger-ee-help-tour">'.$tour->get_label().'</button>';
                 }
                 $tour_buttons .= implode('<br />', $tb);
                 $tour_buttons .= '</div></div>';
@@ -1025,7 +1025,7 @@ 
                     throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
                             'event_espresso'), $config['help_sidebar'], get_class($this)));
                 }
-                $content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
+                $content = apply_filters('FHEE__'.get_class($this).'__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
                 $content .= $tour_buttons; //add help tour buttons.
                 //do we have any help tours setup?  Cause if we do we want to add the buttons
                 $this->_current_screen->set_help_sidebar($content);
@@ -1038,13 +1038,13 @@ 
             if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
                 $_ht['id'] = $this->page_slug;
                 $_ht['title'] = __('Help Tours', 'event_espresso');
-                $_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
+                $_ht['content'] = '<p>'.__('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso').'</p>';
                 $this->_current_screen->add_help_tab($_ht);
             }/**/
             if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
-            foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
+            foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 //we're here so there ARE help tabs!
                 //make sure we've got what we need
                 if ( ! isset($cfg['title'])) {
@@ -1059,9 +1059,9 @@ 
                     $content = ! empty($cfg['content']) ? $cfg['content'] : null;
                     //second priority goes to filename
                 } else if ( ! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     //it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
+                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES.basename($this->_get_dir()).'/help_tabs/'.$cfg['filename'].'.help_tab.php' : $file_path;
                     //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
                     if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
                         EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
@@ -1080,7 +1080,7 @@ 
                     return;
                 }
                 //setup config array for help tab method
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+                $id = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
                 $_ht = array(
                         'id'       => $id,
                         'title'    => $cfg['title'],
@@ -1118,9 +1118,9 @@ 
             }
             if (isset($config['help_tour'])) {
                 foreach ($config['help_tour'] as $tour) {
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
+                    $file_path = $this->_get_dir().'/help_tours/'.$tour.'.class.php';
                     //let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
+                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES.basename($this->_get_dir()).'/help_tours/'.$tour.'.class.php' : $file_path;
                     //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
                     if ( ! is_readable($file_path)) {
                         EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
@@ -1130,7 +1130,7 @@ 
                     require_once $file_path;
                     if ( ! class_exists($tour)) {
                         $error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
-                        $error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
+                        $error_msg[] = $error_msg[0]."\r\n".sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
                                         'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
                         throw new EE_Error(implode('||', $error_msg));
                     }
@@ -1162,11 +1162,11 @@ 
     protected function _add_qtips()
     {
         if (isset($this->_route_config['qtips'])) {
-            $qtips = (array)$this->_route_config['qtips'];
+            $qtips = (array) $this->_route_config['qtips'];
             //load qtip loader
             $path = array(
-                    $this->_get_dir() . '/qtips/',
-                    EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+                    $this->_get_dir().'/qtips/',
+                    EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
             );
             EEH_Qtip_Loader::instance()->register($qtips, $path);
         }
@@ -1196,11 +1196,11 @@ 
             if ( ! $this->check_user_access($slug, true)) {
                 continue;
             } //no nav tab becasue current user does not have access.
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+            $css_class = isset($config['css_class']) ? $config['css_class'].' ' : '';
             $this->_nav_tabs[$slug] = array(
                     'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
                     'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
-                    'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
+                    'css_class' => $this->_req_action == $slug ? $css_class.'nav-tab-active' : $css_class,
                     'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
             );
             $i++;
@@ -1263,11 +1263,11 @@ 
             $capability = empty($capability) ? 'manage_options' : $capability;
         }
         $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
-        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
+        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug.'_'.$route_to_check, $id)) && ! defined('DOING_AJAX')) {
             if ($verify_only) {
                 return false;
             } else {
-                if ( is_user_logged_in() ) {
+                if (is_user_logged_in()) {
                     wp_die(__('You do not have access to this route.', 'event_espresso'));
                 } else {
                     return false;
@@ -1359,7 +1359,7 @@ 
     public function admin_footer_global()
     {
         //dialog container for dialog helper
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
+        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">'."\n";
         $d_cont .= '<div class="ee-notices"></div>';
         $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
         $d_cont .= '</div>';
@@ -1369,7 +1369,7 @@ 
             echo implode('<br />', $this->_help_tour[$this->_req_action]);
         }
         //current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
+        echo '<span id="current_timezone" class="hidden">'.EEH_DTT_Helper::get_timezone().'</span>';
     }
 
 
@@ -1394,7 +1394,7 @@ 
     {
         $content = '';
         $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_help_popup.template.php';
         //loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             //make sure the array is setup properly
@@ -1428,7 +1428,7 @@ 
     private function _get_help_content()
     {
         //what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         //if method doesn't exist let's get out.
         if ( ! method_exists($this, $method_name)) {
             return array();
@@ -1472,8 +1472,8 @@ 
             $help_content = $this->_set_help_popup_content($help_array, false);
         }
         //let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content = $content . $help_content;
+        $content = '<a class="ee-dialog" href="?height='.$dimensions[0].'&width='.$dimensions[1].'&inlineId='.$trigger_id.'" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+        $content = $content.$help_content;
         if ($display) {
             echo $content;
         } else {
@@ -1533,27 +1533,27 @@ 
             add_action('admin_head', array($this, 'add_xdebug_style'));
         }
         // register all styles
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-admin-css', EE_ADMIN_URL.'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
         //helpers styles
-        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
         /** SCRIPTS **/
         //register all scripts
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-dialog', EE_ADMIN_URL.'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee_admin_js', EE_ADMIN_URL.'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL.'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
         add_filter('FHEE_load_joyride', '__return_true');
         //script for sorting tables
-        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL."assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
         //script for parsing uri's
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL.'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
         //and parsing associative serialized form elements
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL.'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
         //helpers scripts
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL.'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-moment', EE_THIRD_PARTY_URL.'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-datepicker', EE_ADMIN_URL.'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
         //google charts
         wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
         // ENQUEUE ALL BASICS BY DEFAULT
@@ -1577,7 +1577,7 @@ 
          */
         if ( ! empty($this->_help_tour)) {
             //register the js for kicking things off
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
+            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL.'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
             //setup tours for the js tour object
             foreach ($this->_help_tour['tours'] as $tour) {
                 $tours[] = array(
@@ -1672,17 +1672,17 @@ 
             return;
         } //not a list_table view so get out.
         //list table functions are per view specific (because some admin pages might have more than one listtable!)
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
+        if (call_user_func(array($this, '_set_list_table_views_'.$this->_req_action)) === false) {
             //user error msg
             $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
             //developer error msg
-            $error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
+            $error_msg .= '||'.sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
+                            $this->_req_action, '_set_list_table_views_'.$this->_req_action);
             throw new EE_Error($error_msg);
         }
         //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -1757,7 +1757,7 @@ 
             // check for current view
             $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
             $query_args['action'] = $this->_req_action;
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
             $query_args['status'] = $view['slug'];
             //merge any other arguments sent in.
             if (isset($extra_query_args[$view['slug']])) {
@@ -1795,14 +1795,14 @@ 
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
         foreach ($values as $value) {
             if ($value < $max_entries) {
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
+                $selected = $value == $per_page ? ' selected="'.$per_page.'"' : '';
                 $entries_per_page_dropdown .= '
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
             }
         }
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
+        $selected = $max_entries == $per_page ? ' selected="'.$per_page.'"' : '';
         $entries_per_page_dropdown .= '
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
         $entries_per_page_dropdown .= '
 					</select>
 					entries
@@ -1824,7 +1824,7 @@ 
     public function _set_search_attributes()
     {
         $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
     }
 
     /*** END LIST TABLE METHODS **/
@@ -1862,7 +1862,7 @@ 
                     // user error msg
                     $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
                     // developer error msg
-                    $error_msg .= '||' . sprintf(
+                    $error_msg .= '||'.sprintf(
                                     __(
                                             'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
                                             'event_espresso'
@@ -1892,15 +1892,15 @@ 
                 && is_array($this->_route_config['columns'])
                 && count($this->_route_config['columns']) === 2
         ) {
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
+            add_screen_option('layout_columns', array('max' => (int) $this->_route_config['columns'][0], 'default' => (int) $this->_route_config['columns'][1]));
             $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
             $screen_id = $this->_current_screen->id;
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
+            $screen_columns = (int) get_user_option("screen_layout_$screen_id");
             $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
             $this->_template_args['current_page'] = $this->_wp_page_slug;
             $this->_template_args['screen'] = $this->_current_screen;
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
+            $this->_column_template_path = EE_ADMIN_TEMPLATE.'admin_details_metabox_column_wrapper.template.php';
             //finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
             $this->_route_config['has_metaboxes'] = true;
         }
@@ -1947,7 +1947,7 @@ 
      */
     public function espresso_ratings_request()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php';
         EEH_Template::display_template($template_path, array());
     }
 
@@ -1955,18 +1955,18 @@ 
 
     public static function cached_rss_display($rss_id, $url)
     {
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
+        $loading = '<p class="widget-loading hide-if-no-js">'.__('Loading&#8230;').'</p><p class="hide-if-js">'.__('This widget requires JavaScript.').'</p>';
         $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
-        $post = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.$rss_id.'_url" class="hidden">'.$url.'</span>';
+        $post = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         if (false != ($output = get_transient($cache_key))) {
-            echo $pre . $output . $post;
+            echo $pre.$output.$post;
             return true;
         }
         if ( ! $doing_ajax) {
-            echo $pre . $loading . $post;
+            echo $pre.$loading.$post;
             return false;
         }
         ob_start();
@@ -2025,7 +2025,7 @@ 
 
     public function espresso_sponsors_post_box()
     {
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
+        $templatepath = EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php';
         EEH_Template::display_template($templatepath);
     }
 
@@ -2033,7 +2033,7 @@ 
 
     private function _publish_post_box()
     {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+        $meta_box_ref = 'espresso_'.$this->page_slug.'_editor_overview';
         //if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
         if ( ! empty($this->_labels['publishbox'])) {
             $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
@@ -2050,7 +2050,7 @@ 
     {
         //if we have extra content set let's add it in if not make sure its empty
         $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2219,7 +2219,7 @@ 
         //if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func ? create_function('$post, $metabox',
                 'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
+        add_meta_box(str_replace('_', '-', $action).'-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
     }
 
 
@@ -2299,10 +2299,10 @@ 
                 ? 'poststuff'
                 : 'espresso-default-admin';
         $template_path = $sidebar
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+                ? EE_ADMIN_TEMPLATE.'admin_details_wrapper.template.php'
+                : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
         $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
@@ -2348,7 +2348,7 @@ 
                         true
                 )
                 : $this->_template_args['preview_action_button'];
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
                 $template_path,
                 $this->_template_args,
@@ -2399,7 +2399,7 @@ 
         //setup search attributes
         $this->_set_search_attributes();
         $this->_template_args['current_page'] = $this->_wp_page_slug;
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
         $this->_template_args['table_url'] = defined('DOING_AJAX')
                 ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
                 : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
@@ -2409,29 +2409,29 @@ 
         $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
         if ( ! empty($ajax_sorting_callback)) {
             $sortable_list_table_form_fields = wp_nonce_field(
-                    $ajax_sorting_callback . '_nonce',
-                    $ajax_sorting_callback . '_nonce',
+                    $ajax_sorting_callback.'_nonce',
+                    $ajax_sorting_callback.'_nonce',
                     false,
                     false
             );
             //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
             //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
+            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'.$this->page_slug.'" />';
+            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'.$ajax_sorting_callback.'" />';
         } else {
             $sortable_list_table_form_fields = '';
         }
         $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
         $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
-        $nonce_ref = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+        $nonce_ref = $this->_req_action.'_nonce';
+        $hidden_form_fields .= '<input type="hidden" name="'.$nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
         $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         //display message about search results?
         $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
-                ? '<p class="ee-search-results">' . sprintf(
+                ? '<p class="ee-search-results">'.sprintf(
                         esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                         trim($this->_req_data['s'], '%')
-                ) . '</p>'
+                ).'</p>'
                 : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -2505,8 +2505,8 @@ 
      */
     protected function _display_legend($items)
     {
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
+        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array) $items, $this);
+        $legend_template = EE_ADMIN_TEMPLATE.'admin_details_legend.template.php';
         return EEH_Template::display_template($legend_template, $this->_template_args, true);
     }
 
@@ -2598,15 +2598,15 @@ 
         $this->_nav_tabs = $this->_get_main_nav_tabs();
         $this->_template_args['nav_tabs'] = $this->_nav_tabs;
         $this->_template_args['admin_page_title'] = $this->_admin_page_title;
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
+        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content'.$this->_current_page.$this->_current_view,
                 isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
+        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content'.$this->_current_page.$this->_current_view,
                 isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
         $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
         // load settings page wrapper template
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE.'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php';
         //about page?
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
+        $template_path = $about ? EE_ADMIN_TEMPLATE.'about_admin_wrapper.template.php' : $template_path;
         if (defined('DOING_AJAX')) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
             $this->_return_json();
@@ -2678,20 +2678,20 @@ 
     protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
     {
         //make sure $text and $actions are in an array
-        $text = (array)$text;
-        $actions = (array)$actions;
+        $text = (array) $text;
+        $actions = (array) $actions;
         $referrer_url = empty($referrer) ? '' : $referrer;
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
+        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'.$_SERVER['REQUEST_URI'].'" />'
+                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'.$referrer.'" />';
         $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
         $default_names = array('save', 'save_and_close');
         //add in a hidden index for the current page (so save and close redirects properly)
         $this->_template_args['save_buttons'] = $referrer_url;
         foreach ($button_text as $key => $button) {
             $ref = $default_names[$key];
-            $id = $this->_current_view . '_' . $ref;
+            $id = $this->_current_view.'_'.$ref;
             $name = ! empty($actions) ? $actions[$key] : $ref;
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
+            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '.$ref.'" value="'.$button.'" name="'.$name.'" id="'.$id.'" />';
             if ( ! $both) {
                 break;
             }
@@ -2727,15 +2727,15 @@ 
     {
         if (empty($route)) {
             $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            $dev_msg = $user_msg."\n".sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
+        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'.$this->_admin_base_url.'" id="'.$route.'_event_form" >';
         // add nonce
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+        $nonce = wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
         //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = array(
                 'action' => array('type' => 'hidden', 'value' => $route),
@@ -2745,8 +2745,8 @@ 
         // generate form fields
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
-        foreach ((array)$form_fields as $field_name => $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+        foreach ((array) $form_fields as $field_name => $form_field) {
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -2827,7 +2827,7 @@ 
          * @param array $query_args       The original query_args array coming into the
          *                                method.
          */
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
+        do_action('AHEE__'.$classname.'___redirect_after_action__before_redirect_modification_'.$this->_req_action, $query_args);
         //calculate where we're going (if we have a "save and close" button pushed)
         if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
             // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
@@ -2843,7 +2843,7 @@ 
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
                 //is there a wp_referer array in our _default_route_query_args property?
                 if ($query_param == 'wp_referer') {
-                    $query_value = (array)$query_value;
+                    $query_value = (array) $query_value;
                     foreach ($query_value as $reference => $value) {
                         if (strpos($reference, 'nonce') !== false) {
                             continue;
@@ -2869,11 +2869,11 @@ 
         // if redirecting to anything other than the main page, add a nonce
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         //we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
+        do_action('AHEE_redirect_'.$classname.$this->_req_action, $query_args);
+        $redirect_url = apply_filters('FHEE_redirect_'.$classname.$this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if (defined('DOING_AJAX')) {
             $default_data = array(
@@ -3003,7 +3003,7 @@ 
         $args = array(
                 'label'   => $this->_admin_page_title,
                 'default' => 10,
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+                'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
         );
         //ONLY add the screen option if the user has access to it.
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3036,8 +3036,8 @@ 
             $map_option = $option;
             $option = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $value = (int)$value;
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
+                    $value = (int) $value;
                     if ($value < 1 || $value > 999) {
                         return;
                     }
@@ -3064,7 +3064,7 @@ 
      */
     public function set_template_args($data)
     {
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
+        $this->_template_args = array_merge($this->_template_args, (array) $data);
     }
 
 
@@ -3086,12 +3086,12 @@ 
             $this->_verify_route($route);
         }
         //now let's set the string for what kind of transient we're setting
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+        $transient = $notices ? 'ee_rte_n_tx_'.$route.'_'.$user_id : 'rte_tx_'.$route.'_'.$user_id;
         $data = $notices ? array('notices' => $data) : $data;
         //is there already a transient for this route?  If there is then let's ADD to that transient
         $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
         if ($existing) {
-            $data = array_merge((array)$data, (array)$existing);
+            $data = array_merge((array) $data, (array) $existing);
         }
         if (is_multisite() && is_network_admin()) {
             set_site_transient($transient, $data, 8);
@@ -3112,7 +3112,7 @@ 
     {
         $user_id = get_current_user_id();
         $route = ! $route ? $this->_req_action : $route;
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
+        $transient = $notices ? 'ee_rte_n_tx_'.$route.'_'.$user_id : 'rte_tx_'.$route.'_'.$user_id;
         $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
         //delete transient after retrieval (just in case it hasn't expired);
         if (is_multisite() && is_network_admin()) {
@@ -3353,7 +3353,7 @@ 
      */
     protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -3367,7 +3367,7 @@ 
      */
     protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }