eventespresso / event-espresso-core

core/db_models/relations/EE_Belongs_To_Any_Relation.php

Indentation +84 added lines, -84 removed lines

@@ -16,94 +16,94 @@
 {
 
 
-    /**
-     * 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 +5 added lines, -5 removed lines

@@ -35,19 +35,19 @@
         $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(
+        ).$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);
+        ).$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_Has_Many_Relation.php

Indentation +90 added lines, -90 removed lines

@@ -11,102 +11,102 @@
 class EE_Has_Many_Relation extends EE_Model_Relation_Base
 {
 
-    /**
-     * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
-     * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
-     * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
-     * related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
-     *                                               related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes = true, $blocking_delete_error_message = null)
-    {
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
+	 * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
+	 * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
+	 * related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 For this type of r elation, we block by default. If there are
+	 *                                               related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes = true, $blocking_delete_error_message = null)
+	{
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        // create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_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();
-        $fk_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_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		// create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_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();
+		$fk_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_fk_field->get_table_alias();
+		$fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
-        return $this->_left_join(
-            $fk_table,
-            $fk_table_alias,
-            $other_table_fk_field->get_table_column(),
-            $pk_table_alias,
-            $this_table_pk_field->get_table_column()
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join(
+			$fk_table,
+			$fk_table_alias,
+			$other_table_fk_field->get_table_column(),
+			$pk_table_alias,
+			$this_table_pk_field->get_table_column()
+		) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this 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);
+	/**
+	 * Sets the other model object's foreign key to this 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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
-            // set that field on the other model to this model's ID
-            $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-            $other_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
+			// set that field on the other model to this model's ID
+			$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+			$other_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @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())
-    {
-        $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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @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())
+	{
+		$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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -46,12 +46,12 @@ 
         $pk_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();
-        $fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+        ).$this_table_pk_field->get_table_alias();
+        $fk_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_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+        ).$other_table_fk_field->get_table_alias();
+        $fk_table = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
         return $this->_left_join(
             $fk_table,
@@ -59,7 +59,7 @@ 
             $other_table_fk_field->get_table_column(),
             $pk_table_alias,
             $this_table_pk_field->get_table_column()
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+        ).$this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
     }
 
 

core/db_models/relations/EE_Belongs_To_Relation.php

Spacing +7 added lines, -7 removed lines

@@ -45,19 +45,19 @@ 
         $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(
+        ).$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);
+        ).$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->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 
 
@@ -139,8 +139,8 @@ 
         }
         $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);
+        $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);

Indentation +123 added lines, -123 removed lines

@@ -12,137 +12,137 @@
 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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_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);
+	}
 }

core/db_models/relations/EE_HABTM_Any_Relation.php

Indentation +265 added lines, -265 removed lines

@@ -10,294 +10,294 @@
  */
 class EE_HABTM_Any_Relation extends EE_HABTM_Relation
 {
-    /**
-     * @var string
-     */
-    protected $_alphabetically_first_model_name;
+	/**
+	 * @var string
+	 */
+	protected $_alphabetically_first_model_name;
 
-    /**
-     * 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 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($block_deletes = true, $blocking_delete_error_message = '')
-    {
-        parent::__construct('Extra_Join', $block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param 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($block_deletes = true, $blocking_delete_error_message = '')
+	{
+		parent::__construct('Extra_Join', $block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     * @throws EE_Error
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        if ($this_model_name < $other_model_name) {
-            $this->_alphabetically_first_model_name = $this_model_name;
-        } else {
-            $this->_alphabetically_first_model_name = $other_model_name;
-        }
-        parent::_construct_finalize_set_models($this_model_name, $other_model_name);
-    }
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		if ($this_model_name < $other_model_name) {
+			$this->_alphabetically_first_model_name = $this_model_name;
+		} else {
+			$this->_alphabetically_first_model_name = $other_model_name;
+		}
+		parent::_construct_finalize_set_models($this_model_name, $other_model_name);
+	}
 
 
-    /**
-     * @param string $model_name
-     * @param string $id_or_name_field should be the string 'ID' or 'name' only
-     * @return EE_Model_Field_Base
-     * @throws \EE_Error
-     */
-    public function get_join_table_fk_field_to($model_name, $id_or_name_field)
-    {
-        $order = null;
-        if ($model_name === $this->_alphabetically_first_model_name) {
-            $order = 'first';
-        } else {
-            $order = 'second';
-        }
-        return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
-    }
+	/**
+	 * @param string $model_name
+	 * @param string $id_or_name_field should be the string 'ID' or 'name' only
+	 * @return EE_Model_Field_Base
+	 * @throws \EE_Error
+	 */
+	public function get_join_table_fk_field_to($model_name, $id_or_name_field)
+	{
+		$order = null;
+		if ($model_name === $this->_alphabetically_first_model_name) {
+			$order = 'first';
+		} else {
+			$order = 'second';
+		}
+		return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
+	}
 
 
-    /**
-     * 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();
-        $join_table_fk_field_to_this_table         = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $field_with_model_name                     = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            '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(),
-            $field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
-        ) .
-               $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_to_intermediate_model_statement($model_relation_chain)
+	{
+		// create sql like
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		// remember the model relation chain to the JOIN model, because we'll
+		// need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();
+		$join_table_fk_field_to_this_table         = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$field_with_model_name                     = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'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(),
+			$field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
+		) .
+			   $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
-        return $SQL;
-    }
+		return $SQL;
+	}
 
 
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        if ($this->_model_relation_chain_to_join_model === null) {
-            throw new EE_Error(sprintf(__(
-                'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                'event_espresso'
-            )));
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_table_fk_field_to_other_table = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $field_with_other_model_name        = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * 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_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_table_fk_field_to_other_table = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$field_with_other_model_name        = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'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();
+		$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();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_other_model()->get_this_model_name()
-        ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
+		$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(),
-            $field_with_other_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);
-        return $SQL;
-    }
+		$SQL = $this->_left_join(
+			$other_table,
+			$other_table_alias,
+			$other_table_pk_field->get_table_column(),
+			$join_table_alias,
+			$join_table_fk_field_to_other_table->get_table_column(),
+			$field_with_other_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);
+		return $SQL;
+	}
 
 
-    /**
-     * Ensures there is an entry in the join table between these two models. 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 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_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'name'
-        );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * Ensures there is an entry in the join table between these two models. 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 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_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'name'
+		);
+		$join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'name'
+		);
 
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
-            $join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
-            $join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
-            $join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
-        );
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
+			$join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
+			$join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
+			$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
+		);
 
-        // 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);
-        }
+		// 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);
+		$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;
-    }
+		$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_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'name'
-        );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'name'
+		);
+		$join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'name'
+		);
 
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
-            $join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
-            $join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
-            $join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
-        );
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
+			$join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
+			$join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
+			$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
+		);
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($where_query as $query_param => $val) {
+				$query_param                = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $this->get_join_model()->delete(array($cols_n_values));
-        return $other_model_obj;
-    }
+		$this->get_join_model()->delete(array($cols_n_values));
+		return $other_model_obj;
+	}
 }

Spacing +31 added lines, -31 removed lines

@@ -62,7 +62,7 @@ 
         } else {
             $order = 'second';
         }
-        return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
+        return $this->get_join_model()->field_settings_for('EXJ_'.$order.'_model_'.$id_or_name_field);
     }
 
 
@@ -87,19 +87,19 @@ 
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $field_with_model_name                     = $this->get_join_table_fk_field_to(
+        $field_with_model_name = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+        $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(
+        ).$this_table_pk_field->get_table_alias();
+        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $model_relation_chain,
             $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table                                = $this->get_join_model()->get_table_for_alias($join_table_alias);
+        ).$join_table_fk_field_to_this_table->get_table_alias();
+        $join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
         // phew! ok, we have all the info we need, now we can create the SQL join string
         $SQL = $this->_left_join(
             $join_table,
@@ -107,8 +107,8 @@ 
             $join_table_fk_field_to_this_table->get_table_column(),
             $this_table_alias,
             $this_table_pk_field->get_table_column(),
-            $field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
-        ) .
+            $field_with_model_name->get_qualified_column()."='".$this->get_this_model()->get_this_model_name()."'"
+        ).
                $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
         return $SQL;
@@ -134,7 +134,7 @@ 
                 'event_espresso'
             )));
         }
-        $join_table_fk_field_to_this_table  = $this->get_join_table_fk_field_to(
+        $join_table_fk_field_to_this_table = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
@@ -142,7 +142,7 @@ 
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
-        $field_with_other_model_name        = $this->get_join_table_fk_field_to(
+        $field_with_other_model_name = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'name'
         );
@@ -150,14 +150,14 @@ 
         $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $this->_model_relation_chain_to_join_model,
             $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
+        ).$join_table_fk_field_to_this_table->get_table_alias();
 
         $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
         $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
             $model_relation_chain,
             $this->get_other_model()->get_this_model_name()
-        ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+        ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
         $SQL = $this->_left_join(
             $other_table,
@@ -165,8 +165,8 @@ 
             $other_table_pk_field->get_table_column(),
             $join_table_alias,
             $join_table_fk_field_to_other_table->get_table_column(),
-            $field_with_other_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name() . "'"
-        ) .
+            $field_with_other_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);
         return $SQL;
     }
@@ -188,15 +188,15 @@ 
         $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_table_fk_field_to(
+        $join_model_fk_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+        $join_model_name_field_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_other_model = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
@@ -213,17 +213,17 @@ 
         );
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
+        if ( ! empty($extra_join_model_fields_n_values)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $cols_n_values = array_merge($cols_n_values, $parsed_query);
         }
@@ -235,7 +235,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;
@@ -257,15 +257,15 @@ 
         $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_table_fk_field_to(
+        $join_model_fk_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+        $join_model_name_field_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_other_model = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
@@ -282,17 +282,17 @@ 
         );
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
+        if ( ! empty($where_query)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $cols_n_values = array_merge($cols_n_values, $parsed_query);
         }

core/db_models/relations/EE_Has_Many_Revision_Relation.php

Spacing +7 added lines, -7 removed lines

@@ -190,7 +190,7 @@ 
         // k this is where things differ because NOW what we're going to do is get the PARENTS for the get all related (and we'll also start setting up the return_objs array containing related that DON'T have parent ids, for those that DON'T have parents to merge with our returned objects);
         foreach ($autosave_relations as $a_r) {
             $pid = $a_r->parent();
-            if (! empty($pid)) {
+            if ( ! empty($pid)) {
                 $parent_ids[] = $pid;
             } else {
                 $return_objs[] = $a_r;
@@ -206,9 +206,9 @@ 
         }
 
         // now we setup the query to get all the parents
-        if (! empty($parent_ids)) {
-            $query_param_where_this_model_pk                  = $this->get_this_model()->get_this_model_name() . "." . $this->get_this_model()->get_primary_key_field()->get_name();
-            $query_param[0][ $query_param_where_this_model_pk ] = array('IN', $parent_ids);
+        if ( ! empty($parent_ids)) {
+            $query_param_where_this_model_pk                  = $this->get_this_model()->get_this_model_name().".".$this->get_this_model()->get_primary_key_field()->get_name();
+            $query_param[0][$query_param_where_this_model_pk] = array('IN', $parent_ids);
             $parents                                          = $this->get_other_model()->get_all($query_params);
         }
 
@@ -243,7 +243,7 @@ 
             var_dump($this_obj);
             var_dump($other_obj);/**/
 
-            if (! empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field)) {
+            if ( ! empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field)) {
                 // let's do query on this objects model to see if the incoming pk value on the obj matches any parents in this objects table.
                 $has_parent_obj = $this->get_other_model()->get_one(array(
                     array(
@@ -259,7 +259,7 @@ 
                     $other_obj->set($pk_on_related_model, $has_parent_obj->ID());
                     $other_obj->set($this->_primary_cpt_field, $this_obj->ID());
 
-                    if (! $remove_relation) {
+                    if ( ! $remove_relation) {
                         $other_obj->save();
                         return array($other_obj);
                     } elseif ($remove_relation && ! $this->_blocking_delete) {
@@ -287,7 +287,7 @@ 
             // the last possible condition on a revision is that the incoming other_model object has a fk that == $this_obj pk which means we just return the $other obj and let it save as normal so we see the return at the bottom of this method.
         } else {
             // we only need to do the below IF this is not a remove relation
-            if (! $remove_relation) {
+            if ( ! $remove_relation) {
                 // okay this is is a normal update/save/remove so, let's make sure the other object is not a revision of the current object.
                 // the other object will likely NOT have the correct fk on it (which is the primary_cpt_field_mame) so we must retrieve from the db to get that first.
                 $existing_other_obj    = $this->get_other_model()->get_one_by_ID($other_obj->ID());

Indentation +296 added lines, -296 removed lines

@@ -12,303 +12,303 @@
 {
 
 
-    /**
-     * The Foreign key on the model that acts as the PRIMARY KEY used in special autosave handling where we query for
-     * autosaves (or the Foreign key on other models in relations pointing to this models primary key which is this
-     * value).  The _primary_cpt_field is what is equivalent to the post_id field on a cpt join.
-     *
-     * @var string
-     */
-    private $_primary_cpt_field;
-
-
-    /**
-     * This is what field serves as the "parent" column that is linked with whatever the main model's calling this
-     * relation has as a primary key.  In other words EEM_Event has 'Datetime' => new
-     * EE_Has_Many_Revision_Relation('EVT_ID', 'DTT_parent').  That means that in the EEM_Datetime model the
-     * 'DTT_Parent' field is related to the 'DTT_ID' primary key field (in the same model) because 'DTT_ID' is the
-     * primary key in the other model (EEM_Datetime).
-     *
-     * @var string
-     */
-    private $_parent_pk_relation_field;
-
-
-    /**
-     * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
-     * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
-     * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
-     * related models across the relation, and add-and-remove the relationships.
-     *
-     * @param string  $primary_cpt_field             See property description for details
-     * @param string  $parent_pk_relation_field      This is the field that is "connected" to the $primary_cpt_field.
-     *                                               See property desc for details.
-     * @param boolean $block_deletes                 For this type of relation, we block by default. 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(
-        $primary_cpt_field,
-        $parent_pk_relation_field,
-        $block_deletes = true,
-        $blocking_delete_error_message = null
-    ) {
-        $this->_primary_cpt_field        = $primary_cpt_field;
-        $this->_parent_pk_relation_field = $parent_pk_relation_field;
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
-
-
-    /**
-     * Sets the other model object's foreign key to this 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);
-
-        // handle possible revisions
-        $other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj);
-
-        // if is array, then we've already done the add_relation so let's get out
-        if (is_array($other_model_obj)) {
-            return $other_model_obj[0];
-        }
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
-
-
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this 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);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
-        // handle possible revisions
-        $other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj, true);
-
-
-        // if is array, then we've already done the add_relation so let's get out
-        if (is_array($other_model_obj)) {
-            return $other_model_obj[0];
-        }
-
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-
-
-        // set that field on the other model to this model's ID
-        if ($this->_blocking_delete) {
-            $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-            $other_model_obj->save();
-        } else {
-            $other_model_obj->delete();
-            $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-            return $other_model_obj;
-        }
-        return $other_model_obj;
-    }
-
-
-    /**
-     * This is identical to EE_Model_Relation->get_all_related() except we're going handle special autosave conditions
-     * in here.
-     *
-     * @param  EE_Base_Class|int $model_object_or_id
-     * @param  array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param  boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1'
-            );
-        }
-
-        // if this is an autosave then we're going to get things differently
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return $this->_do_autosave_get_all($model_object_or_id, $query_params);
-        }
-
-        return parent::get_all_related($model_object_or_id, $query_params);
-    }
-
-
-    /**
-     * If we're in the midst of an autosave then we're going to do things a bit differently than the usual
-     * get_all_related (commenting within).  For description of params see the get_all_related() comments
-     *
-     * @access protected
-     * @param      $model_object_or_id
-     * @param      $query_params
-     * @param bool $deprecated
-     * @return \EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    protected function _do_autosave_get_all($model_object_or_id, $query_params, $deprecated = false)
-    {
-
-        // first we check if the post_id for the incoming query is for an autosave.  If it isn't that's what we want!
-        $model_object_id = $this->_get_model_object_id($model_object_or_id);
-
-        $autosave  = wp_get_post_autosave($model_object_id);
-        $id_to_use = $autosave ? $autosave->ID : $model_object_id;
-
-        $autosave_relations = parent::get_all_related($id_to_use, $query_params);
-        $parent_ids         = $parents = array();
-        $return_objs        = array();
-
-        // k this is where things differ because NOW what we're going to do is get the PARENTS for the get all related (and we'll also start setting up the return_objs array containing related that DON'T have parent ids, for those that DON'T have parents to merge with our returned objects);
-        foreach ($autosave_relations as $a_r) {
-            $pid = $a_r->parent();
-            if (! empty($pid)) {
-                $parent_ids[] = $pid;
-            } else {
-                $return_objs[] = $a_r;
-            }
-        }
-
-        // we have to make sure we also include the ORIGINAL values
-        $originals = parent::get_all_related($model_object_or_id, $query_params);
-
-        // merge $originals with $return_objs
-        if ($originals) {
-            $return_objs = array_merge($originals, $return_objs);
-        }
-
-        // now we setup the query to get all the parents
-        if (! empty($parent_ids)) {
-            $query_param_where_this_model_pk                  = $this->get_this_model()->get_this_model_name() . "." . $this->get_this_model()->get_primary_key_field()->get_name();
-            $query_param[0][ $query_param_where_this_model_pk ] = array('IN', $parent_ids);
-            $parents                                          = $this->get_other_model()->get_all($query_params);
-        }
-
-        // var_dump($parents);
-
-
-        // now merge parents with our current $return_objs and send back
-        return array_merge($parents, $return_objs);
-    }
-
-
-    /**
-     * Basically this method gets called to verify if the incoming object needs to be manipulated somewhat because it
-     * is a revision save.  If so, then we change things before sending back.  We also do verifications when this IS
-     * NOT an revision because we always need to make sure that the autosave/revision has parent recorded (which is
-     * sometime delayed if the object is created/saved first by the autosave)
-     *
-     * @param  EE_Base_Class $this_obj
-     * @param  EE_Base_Class $other_obj
-     * @param  boolean       $remove_relation Indicates whether we're doing a remove_relation or add_relation.
-     * @return EE_Base_Class. ($other_obj);
-     * @throws \EE_Error
-     */
-    protected function _check_for_revision($this_obj, $other_obj, $remove_relation = false)
-    {
-        $pk_on_related_model = $this->get_other_model()->get_primary_key_field()->get_name();
-        // now we need to determine if we're in a WP revision save cause if we are we need to do some special handling
-        if ($this_obj->post_type() === 'revision') {
-            // first if $other_obj fk = this_obj pk then we know that this is a pk object, let's make sure there is a matching set for the autosave if there is then we save over it, if there isn't then we need to create a new one.
-            $parent_evt_id = $this_obj->parent();
-            /*var_dump($parent_evt_id);
+	/**
+	 * The Foreign key on the model that acts as the PRIMARY KEY used in special autosave handling where we query for
+	 * autosaves (or the Foreign key on other models in relations pointing to this models primary key which is this
+	 * value).  The _primary_cpt_field is what is equivalent to the post_id field on a cpt join.
+	 *
+	 * @var string
+	 */
+	private $_primary_cpt_field;
+
+
+	/**
+	 * This is what field serves as the "parent" column that is linked with whatever the main model's calling this
+	 * relation has as a primary key.  In other words EEM_Event has 'Datetime' => new
+	 * EE_Has_Many_Revision_Relation('EVT_ID', 'DTT_parent').  That means that in the EEM_Datetime model the
+	 * 'DTT_Parent' field is related to the 'DTT_ID' primary key field (in the same model) because 'DTT_ID' is the
+	 * primary key in the other model (EEM_Datetime).
+	 *
+	 * @var string
+	 */
+	private $_parent_pk_relation_field;
+
+
+	/**
+	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
+	 * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
+	 * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
+	 * related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param string  $primary_cpt_field             See property description for details
+	 * @param string  $parent_pk_relation_field      This is the field that is "connected" to the $primary_cpt_field.
+	 *                                               See property desc for details.
+	 * @param boolean $block_deletes                 For this type of relation, we block by default. 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(
+		$primary_cpt_field,
+		$parent_pk_relation_field,
+		$block_deletes = true,
+		$blocking_delete_error_message = null
+	) {
+		$this->_primary_cpt_field        = $primary_cpt_field;
+		$this->_parent_pk_relation_field = $parent_pk_relation_field;
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
+
+
+	/**
+	 * Sets the other model object's foreign key to this 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);
+
+		// handle possible revisions
+		$other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj);
+
+		// if is array, then we've already done the add_relation so let's get out
+		if (is_array($other_model_obj)) {
+			return $other_model_obj[0];
+		}
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
+
+
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this 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);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
+		// handle possible revisions
+		$other_model_obj = $this->_check_for_revision($this_model_obj, $other_model_obj, true);
+
+
+		// if is array, then we've already done the add_relation so let's get out
+		if (is_array($other_model_obj)) {
+			return $other_model_obj[0];
+		}
+
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+
+
+		// set that field on the other model to this model's ID
+		if ($this->_blocking_delete) {
+			$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+			$other_model_obj->save();
+		} else {
+			$other_model_obj->delete();
+			$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+			return $other_model_obj;
+		}
+		return $other_model_obj;
+	}
+
+
+	/**
+	 * This is identical to EE_Model_Relation->get_all_related() except we're going handle special autosave conditions
+	 * in here.
+	 *
+	 * @param  EE_Base_Class|int $model_object_or_id
+	 * @param  array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param  boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1'
+			);
+		}
+
+		// if this is an autosave then we're going to get things differently
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return $this->_do_autosave_get_all($model_object_or_id, $query_params);
+		}
+
+		return parent::get_all_related($model_object_or_id, $query_params);
+	}
+
+
+	/**
+	 * If we're in the midst of an autosave then we're going to do things a bit differently than the usual
+	 * get_all_related (commenting within).  For description of params see the get_all_related() comments
+	 *
+	 * @access protected
+	 * @param      $model_object_or_id
+	 * @param      $query_params
+	 * @param bool $deprecated
+	 * @return \EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	protected function _do_autosave_get_all($model_object_or_id, $query_params, $deprecated = false)
+	{
+
+		// first we check if the post_id for the incoming query is for an autosave.  If it isn't that's what we want!
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
+
+		$autosave  = wp_get_post_autosave($model_object_id);
+		$id_to_use = $autosave ? $autosave->ID : $model_object_id;
+
+		$autosave_relations = parent::get_all_related($id_to_use, $query_params);
+		$parent_ids         = $parents = array();
+		$return_objs        = array();
+
+		// k this is where things differ because NOW what we're going to do is get the PARENTS for the get all related (and we'll also start setting up the return_objs array containing related that DON'T have parent ids, for those that DON'T have parents to merge with our returned objects);
+		foreach ($autosave_relations as $a_r) {
+			$pid = $a_r->parent();
+			if (! empty($pid)) {
+				$parent_ids[] = $pid;
+			} else {
+				$return_objs[] = $a_r;
+			}
+		}
+
+		// we have to make sure we also include the ORIGINAL values
+		$originals = parent::get_all_related($model_object_or_id, $query_params);
+
+		// merge $originals with $return_objs
+		if ($originals) {
+			$return_objs = array_merge($originals, $return_objs);
+		}
+
+		// now we setup the query to get all the parents
+		if (! empty($parent_ids)) {
+			$query_param_where_this_model_pk                  = $this->get_this_model()->get_this_model_name() . "." . $this->get_this_model()->get_primary_key_field()->get_name();
+			$query_param[0][ $query_param_where_this_model_pk ] = array('IN', $parent_ids);
+			$parents                                          = $this->get_other_model()->get_all($query_params);
+		}
+
+		// var_dump($parents);
+
+
+		// now merge parents with our current $return_objs and send back
+		return array_merge($parents, $return_objs);
+	}
+
+
+	/**
+	 * Basically this method gets called to verify if the incoming object needs to be manipulated somewhat because it
+	 * is a revision save.  If so, then we change things before sending back.  We also do verifications when this IS
+	 * NOT an revision because we always need to make sure that the autosave/revision has parent recorded (which is
+	 * sometime delayed if the object is created/saved first by the autosave)
+	 *
+	 * @param  EE_Base_Class $this_obj
+	 * @param  EE_Base_Class $other_obj
+	 * @param  boolean       $remove_relation Indicates whether we're doing a remove_relation or add_relation.
+	 * @return EE_Base_Class. ($other_obj);
+	 * @throws \EE_Error
+	 */
+	protected function _check_for_revision($this_obj, $other_obj, $remove_relation = false)
+	{
+		$pk_on_related_model = $this->get_other_model()->get_primary_key_field()->get_name();
+		// now we need to determine if we're in a WP revision save cause if we are we need to do some special handling
+		if ($this_obj->post_type() === 'revision') {
+			// first if $other_obj fk = this_obj pk then we know that this is a pk object, let's make sure there is a matching set for the autosave if there is then we save over it, if there isn't then we need to create a new one.
+			$parent_evt_id = $this_obj->parent();
+			/*var_dump($parent_evt_id);
             var_dump($this_obj);
             var_dump($other_obj);/**/
 
-            if (! empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field)) {
-                // let's do query on this objects model to see if the incoming pk value on the obj matches any parents in this objects table.
-                $has_parent_obj = $this->get_other_model()->get_one(array(
-                    array(
-                        $this->_parent_pk_relation_field => $other_obj->ID(),
-                        $this->_primary_cpt_field        => $this_obj->ID(),
-                    ),
-                ));
-
-                if ($has_parent_obj) {
-                    // this makes sure the update on the current obj happens to the revision's row NOT the parent row.
-
-                    $other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
-                    $other_obj->set($pk_on_related_model, $has_parent_obj->ID());
-                    $other_obj->set($this->_primary_cpt_field, $this_obj->ID());
-
-                    if (! $remove_relation) {
-                        $other_obj->save();
-                        return array($other_obj);
-                    } elseif ($remove_relation && ! $this->_blocking_delete) {
-                        $other_obj->delete();
-                        $other_obj->set($this->_parent_pk_relation_field, null, true);
-                        return array($other_obj);
-                    }
-                } else {
-                    $other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
-                    $other_obj->set($this->_primary_cpt_field, $this_obj->ID());
-                    $other_obj->set(
-                        $pk_on_related_model,
-                        null,
-                        true
-                    ); // ensure we create a new row for the autosave with parent id the same as the incoming ID.
-                    $other_obj->save(); // make sure we insert.
-                    return array($other_obj);
-                }
-            }
-
-            // var_dump('what makes it here');
-            // var_dump($other_obj);
-            // the next possible condition is that the incoming other_model obj has a NULL pk which means it just gets saved (which in turn creates it)
-
-            // the last possible condition on a revision is that the incoming other_model object has a fk that == $this_obj pk which means we just return the $other obj and let it save as normal so we see the return at the bottom of this method.
-        } else {
-            // we only need to do the below IF this is not a remove relation
-            if (! $remove_relation) {
-                // okay this is is a normal update/save/remove so, let's make sure the other object is not a revision of the current object.
-                // the other object will likely NOT have the correct fk on it (which is the primary_cpt_field_mame) so we must retrieve from the db to get that first.
-                $existing_other_obj    = $this->get_other_model()->get_one_by_ID($other_obj->ID());
-                $potential_revision_id = is_object($existing_other_obj) ? $existing_other_obj->get($this->_primary_cpt_field) : null;
-
-                if ($parent_this_obj_id = wp_is_post_revision($potential_revision_id)) {
-                    // yes the OTHER object is linked to the revision of the parent, not the parent itself. That means we need to make the other_object an attachment of this_obj and then duplicate other_obj for the revision.
-                    $other_obj->set($this->_primary_cpt_field, $this_obj->ID());
-                    $other_obj->save();
-
-                    // now create a new other_obj and fill with details from existing object
-                    $new_obj = $other_obj;
-                    $new_obj->set($this->_primary_cpt_field, $potential_revision_id);
-                    $new_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
-                    $new_obj->set($pk_on_related_model, null);
-                    $new_obj->save();
-                    return array($new_obj);
-                }
-            }
-        }
-
-        return $other_obj;
-    }
+			if (! empty($parent_evt_id) && $parent_evt_id == $other_obj->get($this->_primary_cpt_field)) {
+				// let's do query on this objects model to see if the incoming pk value on the obj matches any parents in this objects table.
+				$has_parent_obj = $this->get_other_model()->get_one(array(
+					array(
+						$this->_parent_pk_relation_field => $other_obj->ID(),
+						$this->_primary_cpt_field        => $this_obj->ID(),
+					),
+				));
+
+				if ($has_parent_obj) {
+					// this makes sure the update on the current obj happens to the revision's row NOT the parent row.
+
+					$other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$other_obj->set($pk_on_related_model, $has_parent_obj->ID());
+					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
+
+					if (! $remove_relation) {
+						$other_obj->save();
+						return array($other_obj);
+					} elseif ($remove_relation && ! $this->_blocking_delete) {
+						$other_obj->delete();
+						$other_obj->set($this->_parent_pk_relation_field, null, true);
+						return array($other_obj);
+					}
+				} else {
+					$other_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
+					$other_obj->set(
+						$pk_on_related_model,
+						null,
+						true
+					); // ensure we create a new row for the autosave with parent id the same as the incoming ID.
+					$other_obj->save(); // make sure we insert.
+					return array($other_obj);
+				}
+			}
+
+			// var_dump('what makes it here');
+			// var_dump($other_obj);
+			// the next possible condition is that the incoming other_model obj has a NULL pk which means it just gets saved (which in turn creates it)
+
+			// the last possible condition on a revision is that the incoming other_model object has a fk that == $this_obj pk which means we just return the $other obj and let it save as normal so we see the return at the bottom of this method.
+		} else {
+			// we only need to do the below IF this is not a remove relation
+			if (! $remove_relation) {
+				// okay this is is a normal update/save/remove so, let's make sure the other object is not a revision of the current object.
+				// the other object will likely NOT have the correct fk on it (which is the primary_cpt_field_mame) so we must retrieve from the db to get that first.
+				$existing_other_obj    = $this->get_other_model()->get_one_by_ID($other_obj->ID());
+				$potential_revision_id = is_object($existing_other_obj) ? $existing_other_obj->get($this->_primary_cpt_field) : null;
+
+				if ($parent_this_obj_id = wp_is_post_revision($potential_revision_id)) {
+					// yes the OTHER object is linked to the revision of the parent, not the parent itself. That means we need to make the other_object an attachment of this_obj and then duplicate other_obj for the revision.
+					$other_obj->set($this->_primary_cpt_field, $this_obj->ID());
+					$other_obj->save();
+
+					// now create a new other_obj and fill with details from existing object
+					$new_obj = $other_obj;
+					$new_obj->set($this->_primary_cpt_field, $potential_revision_id);
+					$new_obj->set($this->_parent_pk_relation_field, $other_obj->ID());
+					$new_obj->set($pk_on_related_model, null);
+					$new_obj->save();
+					return array($new_obj);
+				}
+			}
+		}
+
+		return $other_obj;
+	}
 }

core/db_models/relations/EE_Has_Many_Any_Relation.php

Indentation +84 added lines, -84 removed lines

@@ -15,94 +15,94 @@
 class EE_Has_Many_Any_Relation extends EE_Has_Many_Relation
 {
 
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        // create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field   = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field  = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_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();
-        $fk_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_fk_field->get_table_alias();
-        $fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
-        $field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		// create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field   = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field  = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_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();
+		$fk_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_fk_field->get_table_alias();
+		$fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+		$field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
 
-        return $this->_left_join(
-            $fk_table,
-            $fk_table_alias,
-            $other_table_fk_field->get_table_column(),
-            $pk_table_alias,
-            $this_table_pk_field->get_table_column(),
-            $fk_table_alias . '.' . $field_with_model_name->get_table_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
-        )
-               . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join(
+			$fk_table,
+			$fk_table_alias,
+			$other_table_fk_field->get_table_column(),
+			$pk_table_alias,
+			$this_table_pk_field->get_table_column(),
+			$fk_table_alias . '.' . $field_with_model_name->get_table_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
+		)
+			   . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this 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);
+	/**
+	 * Sets the other model object's foreign key to this 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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-        $other_model_obj->set(
-            $this->get_other_model()->get_field_containing_related_model_name()->get_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+		$other_model_obj->set(
+			$this->get_other_model()->get_field_containing_related_model_name()->get_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @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())
-    {
-        $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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->set(
-            $this->get_other_model()->get_field_containing_related_model_name()->get_name(),
-            null,
-            true
-        );
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @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())
+	{
+		$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_field_on_other_model = $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->set(
+			$this->get_other_model()->get_field_containing_related_model_name()->get_name(),
+			null,
+			true
+		);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -32,11 +32,11 @@ 
         $pk_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();
-        $fk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+        ).$this_table_pk_field->get_table_alias();
+        $fk_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_fk_field->get_table_alias();
+        ).$other_table_fk_field->get_table_alias();
         $fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
         $field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
 
@@ -46,7 +46,7 @@ 
             $other_table_fk_field->get_table_column(),
             $pk_table_alias,
             $this_table_pk_field->get_table_column(),
-            $fk_table_alias . '.' . $field_with_model_name->get_table_column() . "='" . $this->get_this_model()->get_this_model_name() . "'"
+            $fk_table_alias.'.'.$field_with_model_name->get_table_column()."='".$this->get_this_model()->get_this_model_name()."'"
         )
                . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
     }

core/db_models/EEM_Status.model.php

Indentation +277 added lines, -277 removed lines

@@ -11,292 +11,292 @@
 class EEM_Status extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = __('Status', 'event_espresso');
-        $this->plural_item      = __('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    __("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => __("Event", "event_espresso"),// deprecated
-                        'registration' => __("Registration", "event_espresso"),
-                        'transaction'  => __("Transaction", "event_espresso"),
-                        'payment'      => __("Payment", "event_espresso"),
-                        'email'        => __("Email", "event_espresso"),
-                        'message'      => __("Message", "event_espresso"),
-                    )
-                ),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false, false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = __('Status', 'event_espresso');
+		$this->plural_item      = __('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', __('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', __('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => __("Event", "event_espresso"),// deprecated
+						'registration' => __("Registration", "event_espresso"),
+						'transaction'  => __("Transaction", "event_espresso"),
+						'payment'      => __("Payment", "event_espresso"),
+						'email'        => __("Email", "event_espresso"),
+						'message'      => __("Message", "event_espresso"),
+					)
+				),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', __('Editable?', 'event_espresso'), false, false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', __("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', __("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        // note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                __('pending payment', 'event_espresso'), // singular
-                __('pending payments', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                __('approved', 'event_espresso'), // singular
-                __('approved', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                __('not approved', 'event_espresso'),
-                __('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                __('wait list', 'event_espresso'),
-                __('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                __('overpaid', 'event_espresso'),
-                __('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                __('complete', 'event_espresso'),
-                __('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                __('incomplete', 'event_espresso'),
-                __('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                __('abandoned', 'event_espresso'),
-                __('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                __('accepted', 'event_espresso'),
-                __('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                __('declined', 'event_espresso'),
-                __('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            // following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                __('postponed', 'event_espresso'),
-                __('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                __('archived', 'event_espresso'),
-                __('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                __('on sale', 'event_espresso'),
-                __('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                __('cancelled', 'event_espresso'),
-                __('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                __('sold out', 'event_espresso'),
-                __('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                __('expired', 'event_espresso'),
-                __('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                __('inactive', 'event_espresso'),
-                __('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                __('upcoming', 'event_espresso'),
-                __('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                __('active', 'event_espresso'),
-                __('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                __('postponed', 'event_espresso'),
-                __('postponed', 'event_espresso'),
-            ),
-            // messages related
-            EEM_Message::status_sent                    => array(
-                __('sent', 'event_espresso'),
-                __('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                __('queued for sending', 'event_espresso'),
-                __('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                __('failed', 'event_espresso'),
-                __('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                __('debug only', 'event_espresso'),
-                __('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                __('messenger is executing', 'event_espresso'),
-                __('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                __('queued for resending', 'event_espresso'),
-                __('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                __('queued for generating', 'event_espresso'),
-                __('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                __('failed sending, can be retried', 'event_espresso'),
-                __('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                __('published', 'event_espresso'),
-                __('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                __('scheduled', 'event_espresso'),
-                __('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                __('draft', 'event_espresso'),
-                __('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                __('pending', 'event_espresso'),
-                __('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                __('private', 'event_espresso'),
-                __('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                __('trashed', 'event_espresso'),
-                __('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		// note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				__('pending payment', 'event_espresso'), // singular
+				__('pending payments', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				__('approved', 'event_espresso'), // singular
+				__('approved', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				__('not approved', 'event_espresso'),
+				__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				__('wait list', 'event_espresso'),
+				__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				__('overpaid', 'event_espresso'),
+				__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				__('complete', 'event_espresso'),
+				__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				__('incomplete', 'event_espresso'),
+				__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				__('abandoned', 'event_espresso'),
+				__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				__('accepted', 'event_espresso'),
+				__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				__('declined', 'event_espresso'),
+				__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			// following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				__('postponed', 'event_espresso'),
+				__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				__('archived', 'event_espresso'),
+				__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				__('on sale', 'event_espresso'),
+				__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				__('cancelled', 'event_espresso'),
+				__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				__('sold out', 'event_espresso'),
+				__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				__('expired', 'event_espresso'),
+				__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				__('inactive', 'event_espresso'),
+				__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				__('upcoming', 'event_espresso'),
+				__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				__('active', 'event_espresso'),
+				__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				__('postponed', 'event_espresso'),
+				__('postponed', 'event_espresso'),
+			),
+			// messages related
+			EEM_Message::status_sent                    => array(
+				__('sent', 'event_espresso'),
+				__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				__('queued for sending', 'event_espresso'),
+				__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				__('failed', 'event_espresso'),
+				__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				__('debug only', 'event_espresso'),
+				__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				__('messenger is executing', 'event_espresso'),
+				__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				__('queued for resending', 'event_espresso'),
+				__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				__('queued for generating', 'event_espresso'),
+				__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				__('failed sending, can be retried', 'event_espresso'),
+				__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				__('published', 'event_espresso'),
+				__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				__('scheduled', 'event_espresso'),
+				__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				__('draft', 'event_espresso'),
+				__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				__('pending', 'event_espresso'),
+				__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				__('private', 'event_espresso'),
+				__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				__('trashed', 'event_espresso'),
+				__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
-            throw new EE_Error(__(
-                'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'
-            ));
-        }
+		if (! is_array($statuses)) {
+			throw new EE_Error(__(
+				'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'
+			));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
-            } else {
-                $translation[ $id ] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[ $id ])) {
+				$translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+			} else {
+				$translation[ $id ] = $code;
+			}
 
-            // schema
-            switch ($schema) {
-                case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
-                    break;
-                case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
-                    break;
-            }
-        }
+			// schema
+			switch ($schema) {
+				case 'lower':
+					$translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence':
+					$translation[ $id ] = ucwords($translation[ $id ]);
+					break;
+				case 'upper':
+					$translation[ $id ] = strtoupper($translation[ $id ]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -35,7 +35,7 @@ 
                     false,
                     'event',
                     array(
-                        'event'        => __("Event", "event_espresso"),// deprecated
+                        'event'        => __("Event", "event_espresso"), // deprecated
                         'registration' => __("Registration", "event_espresso"),
                         'transaction'  => __("Transaction", "event_espresso"),
                         'payment'      => __("Payment", "event_espresso"),
@@ -54,7 +54,7 @@ 
             'Payment'      => new EE_Has_Many_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -267,7 +267,7 @@ 
 
         $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
+        if ( ! is_array($statuses)) {
             throw new EE_Error(__(
                 'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
                 'event_espresso'
@@ -277,22 +277,22 @@ 
         $translation = array();
 
         foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+            if (isset($translation_array[$id])) {
+                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
             } else {
-                $translation[ $id ] = $code;
+                $translation[$id] = $code;
             }
 
             // schema
             switch ($schema) {
                 case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+                    $translation[$id] = strtolower($translation[$id]); // even though these start in lower case, this will catch any statuses added via filter.
                     break;
                 case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
+                    $translation[$id] = ucwords($translation[$id]);
                     break;
                 case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
+                    $translation[$id] = strtoupper($translation[$id]);
                     break;
             }
         }

core/db_models/EEM_Ticket_Price.model.php

Indentation +37 added lines, -37 removed lines

@@ -11,43 +11,43 @@
 class EEM_Ticket_Price extends EEM_Base
 {
 
-    // private instance of the EEM_Ticket_Price object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Price object
+	protected static $_instance = null;
 
-    /**
-     *      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 void
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Ticket Price', 'event_espresso');
-        $this->plural_item = __('Ticket Prices', 'event_espresso');
+	/**
+	 *      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 void
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Ticket Price', 'event_espresso');
+		$this->plural_item = __('Ticket Prices', 'event_espresso');
 
-        $this->_tables = array(
-            'Ticket_Price'=>new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
-        );
-        $this->_fields = array(
-            'Ticket_Price'=> array(
-                'TKP_ID'=>new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
-                'TKT_ID'=>new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
-                'PRC_ID'=>new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket'=>new EE_Belongs_To_Relation(),
-            'Price'=>new EE_Belongs_To_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // follow the caps of the ticket
-        $this->_caps_slug = 'tickets';
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Ticket_Price'=>new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
+		);
+		$this->_fields = array(
+			'Ticket_Price'=> array(
+				'TKP_ID'=>new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
+				'TKT_ID'=>new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
+				'PRC_ID'=>new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket'=>new EE_Belongs_To_Relation(),
+			'Price'=>new EE_Belongs_To_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// follow the caps of the ticket
+		$this->_caps_slug = 'tickets';
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,11 +41,11 @@
             'Price'=>new EE_Belongs_To_Relation()
         );
         $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // follow the caps of the ticket
         $this->_caps_slug = 'tickets';
         parent::__construct($timezone);

core/db_models/helpers/EE_Index.php

Indentation +41 added lines, -41 removed lines

@@ -6,45 +6,45 @@
  */
 class EE_Index
 {
-    protected $_name;
-    protected $_field_names;
-    protected $_model_name;
-    public function __construct($fields)
-    {
-        $this->_field_names = $fields;
-    }
-    public function _construct_finalize($name, $model_name)
-    {
-        $this->_name = $name;
-        $this->_model_name = $model_name;
-    }
-    public function field_names()
-    {
-        return $this->_field_names;
-    }
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance=call_user_func("EEM_".$model_name."::instance");
-        return $modelInstance;
-    }
-    /**
-     * Gets all the fields for this index
-     * @return EE_Model_Field_Base[]
-     */
-    public function fields()
-    {
-        $fields = array();
-        $model = $this->_get_model($this->_model_name);
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (in_array($field_name, $this->field_names())) {
-                $fields[ $field_name ] = $field_obj;
-            }
-        }
-        return $fields;
-    }
+	protected $_name;
+	protected $_field_names;
+	protected $_model_name;
+	public function __construct($fields)
+	{
+		$this->_field_names = $fields;
+	}
+	public function _construct_finalize($name, $model_name)
+	{
+		$this->_name = $name;
+		$this->_model_name = $model_name;
+	}
+	public function field_names()
+	{
+		return $this->_field_names;
+	}
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance=call_user_func("EEM_".$model_name."::instance");
+		return $modelInstance;
+	}
+	/**
+	 * Gets all the fields for this index
+	 * @return EE_Model_Field_Base[]
+	 */
+	public function fields()
+	{
+		$fields = array();
+		$model = $this->_get_model($this->_model_name);
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (in_array($field_name, $this->field_names())) {
+				$fields[ $field_name ] = $field_obj;
+			}
+		}
+		return $fields;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     protected function _get_model($model_name)
     {
-        $modelInstance=call_user_func("EEM_".$model_name."::instance");
+        $modelInstance = call_user_func("EEM_".$model_name."::instance");
         return $modelInstance;
     }
     /**
@@ -42,7 +42,7 @@ 
         $model = $this->_get_model($this->_model_name);
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (in_array($field_name, $this->field_names())) {
-                $fields[ $field_name ] = $field_obj;
+                $fields[$field_name] = $field_obj;
             }
         }
         return $fields;