eventespresso / event-espresso-core

core/db_models/helpers/EE_Primary_Key_Index.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
  * Used to indicate  a primary key index - ie, a set of fields which, when used in combination,
  * also uniquely identify a model object in the database (in case there is no primary key field).
  */
-class EE_Primary_Key_Index extends EE_Unique_Index{
+class EE_Primary_Key_Index extends EE_Unique_Index {
 	//yep, actually the same as unique index right now
 	
 }

core/db_models/helpers/EE_Primary_Table.php

Spacing +5 added lines, -5 removed lines

@@ -4,8 +4,8 @@ 
  * For defining the main table of the model. This is the table with the model's primary key's field. So for CPT models, this will
  * probably be the wp_posts table (so the table name supplied will be 'posts', as the 'wp_' varies). For models only using one table, this will be that table.
  */
-require_once( EE_MODELS . 'helpers/EE_Table_Base.php');
-class EE_Primary_Table extends EE_Table_Base{
+require_once(EE_MODELS.'helpers/EE_Table_Base.php');
+class EE_Primary_Table extends EE_Table_Base {
 
 	/**
 	 *
@@ -15,14 +15,14 @@ 
 	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
 	 *					or whether each site on a multisite install has a copy of this table
 	 */
-	function __construct($table_name, $pk_column = null, $global = false){
-		parent::__construct($table_name, $pk_column, $global );
+	function __construct($table_name, $pk_column = null, $global = false) {
+		parent::__construct($table_name, $pk_column, $global);
 	}
 	/**
 	 * Gets SQL for this table and assigning it an alias. Eg " wp_esp_attendee AS Attendee "
 	 * @return string
 	 */
-	function get_table_sql(){
+	function get_table_sql() {
 		return " ".$this->get_table_name()." AS ".$this->get_table_alias()." ";
 	}
 

core/db_models/helpers/EE_Table_Base.php

Spacing +15 added lines, -15 removed lines

@@ -4,7 +4,7 @@ 
  * Base class for defining the tables that comprise models. This is used to store information
  * about the table\s alias, private key, etc.
  */
-abstract class EE_Table_Base{
+abstract class EE_Table_Base {
 	var $_table_name;
 	var $_table_alias;
 	/**
@@ -21,30 +21,30 @@ 
 	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
 	 *					or whether each site on a multisite install has a copy of this table
 	 */
-	function __construct($table_name, $pk_column, $global = false ){
+	function __construct($table_name, $pk_column, $global = false) {
 		global $wpdb;
-		if( $global ) {
+		if ($global) {
 			$prefix = $wpdb->base_prefix;
 		} else {
 			$prefix = $wpdb->prefix;
 		}
 		//if they didn't add the prefix, let's add it
-		if( strpos( $table_name, $prefix ) !== 0 ) {
-			$table_name = $prefix . $table_name;
+		if (strpos($table_name, $prefix) !== 0) {
+			$table_name = $prefix.$table_name;
 		}
 		$this->_table_name = $table_name;
 		$this->_pk_column = $pk_column;
 	}
 
-	function _construct_finalize_with_alias($table_alias){
+	function _construct_finalize_with_alias($table_alias) {
 		$this->_table_alias = $table_alias;
 	}
 
-	function get_table_name(){
+	function get_table_name() {
 		return $this->_table_name;
 	}
-	function get_table_alias(){
-		if( ! $this->_table_alias){
+	function get_table_alias() {
+		if ( ! $this->_table_alias) {
 			throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
 		}
 		return $this->_table_alias;
@@ -54,7 +54,7 @@ 
 	 *
 	 * @return string name of column of PK
 	 */
-	function get_pk_column(){
+	function get_pk_column() {
 		return $this->_pk_column;
 	}
 
@@ -64,8 +64,8 @@ 
 	 * returns a string with the table alias, a period, and the private key's column.
 	 * @return string
 	 */
-	function get_fully_qualified_pk_column(){
-		$sql =  $this->get_table_alias().".".$this->get_pk_column();
+	function get_fully_qualified_pk_column() {
+		$sql = $this->get_table_alias().".".$this->get_pk_column();
 		return $sql;
 	}
 
@@ -74,9 +74,9 @@ 
 	 * returns the special sql for a inner select with a limit.
 	 * @return string    SQL select
 	 */
-	public function get_select_join_limit( $limit ) {
-		$limit = is_array( $limit ) ? 'LIMIT ' . implode(',', array_map( 'intval', $limit ) ) : 'LIMIT ' . (int) $limit;
-		$SQL = SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+	public function get_select_join_limit($limit) {
+		$limit = is_array($limit) ? 'LIMIT '.implode(',', array_map('intval', $limit)) : 'LIMIT '.(int) $limit;
+		$SQL = SP.'(SELECT * FROM '.$this->_table_name.SP.$limit.') AS '.$this->_table_alias;
 		return $SQL;
 	}
 }

core/db_models/helpers/EE_Unique_Index.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
  * Used to indicate  a UNIQUE key index - ie, a set of fields which must be unique
  * for ALL the model objects of this type
  */
-class EE_Unique_Index extends EE_Index{
+class EE_Unique_Index extends EE_Index {
 	//yep, actually the same as index right now
 	
 }

core/db_models/relations/EE_Belongs_To_Any_Relation.php

Spacing +5 added lines, -5 removed lines

@@ -6,7 +6,7 @@ 
  * in order to specify which model the foreign key points to (eg, the foreign key may have a value of 34, but is that Transaction with
  * ID 34 or Registration with ID 34? The EE_Any_Foreign_Model_name_Field specifies which of the two). 
  */
-require_once( EE_MODELS . 'relations/EE_Belongs_To_Relation.php');
+require_once(EE_MODELS.'relations/EE_Belongs_To_Relation.php');
 
 class EE_Belongs_To_Any_Relation extends EE_Belongs_To_Relation {
 
@@ -19,8 +19,8 @@ 
 		
 		
 		$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();
+		$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, 
@@ -58,12 +58,12 @@ 
 	 */
 	function remove_relation_to($this_obj_or_id, $other_obj_or_id) {
 		$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 );
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
 		//find the field on th eother 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->set($this->get_this_model()->get_field_containing_related_model_name()->get_name(), null, true);
 		$this_model_obj->save();
 		return $other_model_obj;
 	}

core/db_models/relations/EE_HABTM_Relation.php

Spacing +30 added lines, -30 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
-class EE_HABTM_Relation extends EE_Model_Relation_Base{
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
+class EE_HABTM_Relation extends EE_Model_Relation_Base {
 	/**
 	 * Model whicih defines the relation between two other models. Eg, the EE_Event_Question_Group model,
 	 * which joins EE_Event and EE_Question_Group
@@ -18,7 +18,7 @@ 
 	 * @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 type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
+	function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '') {
 		$this->_joining_model_name = $joining_model_name;
 		parent::__construct($block_deletes, $blocking_delete_error_message);
 	}
@@ -26,7 +26,7 @@ 
 	 * Gets the joining model's object
 	 * @return EEM_Base
 	 */
-	function get_join_model(){
+	function get_join_model() {
 		return $this->_get_model($this->_joining_model_name);
 	}
 	/**
@@ -34,21 +34,21 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	function get_join_to_intermediate_model_statement($model_relation_chain){
+	function get_join_to_intermediate_model_statement($model_relation_chain) {
 		//create sql like
 		//LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
 		//LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
 		//remember the model relation chain to the JOIN model, because we'll
 		//need it for get_join_statement()
 		$this->_model_relation_chain_to_join_model = $model_relation_chain;
-		$this_table_pk_field = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$this_table_pk_field = $this->get_this_model()->get_primary_key_field(); //get_foreign_key_to($this->get_other_model()->get_this_model_name());
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+		$this_table_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_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
 		//phew! ok, we have all the info we need, now we can create the SQL join string
-		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
 		return $SQL;
 	}
@@ -60,18 +60,18 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	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' )));
+	function get_join_statement($model_relation_chain) {
+		if ($this->_model_relation_chain_to_join_model === NULL) {
+			throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso')));
 		}
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
 		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
+		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()).$other_table_pk_field->get_table_alias();
 		$other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
 		return $SQL;
 	}
 
@@ -84,36 +84,36 @@ 
 	 * @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
 	 */
-	 function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array() ){
+	 function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		 //if $where_query exists lets add them to the query_params.
-		 if ( !empty( $extra_join_model_fields_n_values ) ) {
+		 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
-		 	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);
+		 	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 );
+		 	$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 ){
+		 if ( ! $existing_entry_in_join_table) {
 			$this->get_join_model()->insert($cols_n_values);
 		}
 		return $other_model_obj;
@@ -125,29 +125,29 @@ 
 	 * * @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
 	 */
-	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){
+	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 		  $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		//if $where_query exists lets add them to the query_params.
-		 if ( !empty( $where_query ) ) {
+		 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
-		 	foreach ( $where_query as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		 	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 );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		 }
 
-		 $existing_entry_in_join_table = $this->get_join_model()->delete( array($cols_n_values) );
+		 $existing_entry_in_join_table = $this->get_join_model()->delete(array($cols_n_values));
 		return $other_model_obj;
 	 }
 }

Doc Comments +1 added lines

@@ -17,6 +17,7 @@
 	 * 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 type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
+	 * @param string $joining_model_name
 	 */
 	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
 		$this->_joining_model_name = $joining_model_name;

core/db_models/relations/EE_Has_Many_Any_Relation.php

Spacing +9 added lines, -9 removed lines

@@ -7,16 +7,16 @@ 
  * ID 34 or Registration with ID 34? The EE_Any_Foreign_Model_name_Field specifies which of the two).
  *
  */
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
-class EE_Has_Many_Any_Relation extends EE_Has_Many_Relation{
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
+class EE_Has_Many_Any_Relation extends EE_Has_Many_Relation {
 
-	function get_join_statement($model_relation_chain){
+	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();
+		$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();
 
@@ -25,7 +25,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);
 	}
 	/**
@@ -34,7 +34,7 @@ 
 	 * @param EE_Base_Class/int $other_obj_or_id
 	 * @return EE_Base_Class
 	 */
-	 function add_relation_to($this_obj_or_id, $other_obj_or_id ){
+	 function add_relation_to($this_obj_or_id, $other_obj_or_id) {
 		 $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);
 
@@ -53,12 +53,12 @@ 
 	 * @param EE_Base_Class/int $other_obj_or_id
 	 * @return EE_Base_Class
 	 */
-	 function remove_relation_to($this_obj_or_id, $other_obj_or_id){
+	 function remove_relation_to($this_obj_or_id, $other_obj_or_id) {
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		 //find the field on th eother 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($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;

core/db_models/relations/EE_Has_Many_Relation.php

Spacing +10 added lines, -10 removed lines

@@ -4,8 +4,8 @@ 
 /**
  * In this relation, the OTHER model ahs the foreign key pointing to this model
  */
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
-class EE_Has_Many_Relation extends EE_Model_Relation_Base{	
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
+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
@@ -15,16 +15,16 @@ 
 	 * @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 type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	function __construct($block_deletes = true, $blocking_delete_error_message = null){
+	function __construct($block_deletes = true, $blocking_delete_error_message = null) {
 		parent::__construct($block_deletes, $blocking_delete_error_message);
 	}
-	function get_join_statement($model_relation_chain){
+	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();
+		$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);
@@ -35,13 +35,13 @@ 
 	 * @param EE_Base_Class/int $other_obj_or_id
 	 * @return EE_Base_Class
 	 */
-	 function add_relation_to($this_obj_or_id, $other_obj_or_id ){
+	 function add_relation_to($this_obj_or_id, $other_obj_or_id) {
 		 $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 th eother 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()){
+		 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();
@@ -55,12 +55,12 @@ 
 	 * @param EE_Base_Class/int $other_obj_or_id
 	 * @return EE_Base_Class
 	 */
-	 function remove_relation_to($this_obj_or_id, $other_obj_or_id){
+	 function remove_relation_to($this_obj_or_id, $other_obj_or_id) {
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		 //find the field on th eother 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($fk_field_on_other_model->get_name(), null, true);
 		 $other_model_obj->save();
 		 return $other_model_obj;
 	 }

core/db_models/relations/EE_Model_Relation_Base.php

Braces +7 added lines, -6 removed lines

@@ -104,8 +104,9 @@ 
 	 * @param string $timezone timezone to set.
 	 */
 	public function set_timezone( $timezone ) {
-		if($timezone !== NULL)
-			$this->_timezone = $timezone;
+		if($timezone !== NULL) {
+					$this->_timezone = $timezone;
+		}
 	}
 
 
@@ -213,12 +214,12 @@ 
 				$deleted_count++;
 				if( ! $delete_is_blocked ){
 					$related_model_object->delete_permanently();
-				}else{
+				} else{
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else{
 				//its not a soft-deletable thing anyways. do the normal logic.
 				if( ! $delete_is_blocked ){
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
@@ -241,7 +242,7 @@ 
 	protected function _get_model_object_id($model_object_or_id) {
 		if($model_object_or_id instanceof EE_Base_Class){
 			$model_object_id = $model_object_or_id->ID();
-		}else{
+		} else{
 			$model_object_id = $model_object_or_id;
 		}
 		if( ! $model_object_id){
@@ -316,7 +317,7 @@ 
 	public function get_deletion_error_message(){
 		if($this->_blocking_delete_error_message){
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else{
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
 				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),

Spacing +46 added lines, -46 removed lines

@@ -7,7 +7,7 @@ 
  * Once those two models are setup correctly, and the relation object has the names of each, it can
  * magically figure out what tables must be joined on what fields during querying.
  */
-abstract class EE_Model_Relation_Base{
+abstract class EE_Model_Relation_Base {
 	/**
 	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
 	 * @var string eg Event, Question_Group, Registration
@@ -42,9 +42,9 @@ 
 	 * @param boolean $block_deletes 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
 	 */
-	function __construct($block_deletes, $blocking_delete_error_message){
+	function __construct($block_deletes, $blocking_delete_error_message) {
 		$this->_blocking_delete = $block_deletes;
-		$this->_blocking_delete_error_message=$blocking_delete_error_message;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
 	}
 
 
@@ -54,12 +54,12 @@ 
 	 * @param $other_model_name
 	 * @throws EE_Error
 	 */
-	function _construct_finalize_set_models($this_model_name, $other_model_name){
+	function _construct_finalize_set_models($this_model_name, $other_model_name) {
 		$this->_this_model_name = $this_model_name;
 		$this->_other_model_name = $other_model_name;
-		if(is_string($this->_blocking_delete)){
+		if (is_string($this->_blocking_delete)) {
 			throw new EE_Error(sprintf(__("When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)", "event_espresso"),
-						get_class($this),$this_model_name,$other_model_name,$this->_blocking_delete));
+						get_class($this), $this_model_name, $other_model_name, $this->_blocking_delete));
 		}
 	}
 
@@ -69,7 +69,7 @@ 
 	 * Gets the model where this relation is defined.
 	 * @return EEM_Base
 	 */
-	function get_this_model(){
+	function get_this_model() {
 		return $this->_get_model($this->_this_model_name);
 	}
 
@@ -80,7 +80,7 @@ 
 	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
 	 * @return EEM_Base
 	 */
-	function get_other_model(){
+	function get_other_model() {
 		return $this->_get_model($this->_other_model_name);
 	}
 
@@ -91,9 +91,9 @@ 
 	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
 	 * @return EEM_Base
 	 */
-	protected function _get_model($model_name){
-		$modelInstance = EE_Registry::instance()->load_model( $model_name );
-		$modelInstance->set_timezone( $this->_timezone );
+	protected function _get_model($model_name) {
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
 		return $modelInstance;
 	}
 
@@ -103,8 +103,8 @@ 
 	 * entirely possible that relations may be called from a model and we need to make sure those relations have their timezone set correctly.
 	 * @param string $timezone timezone to set.
 	 */
-	public function set_timezone( $timezone ) {
-		if($timezone !== NULL)
+	public function set_timezone($timezone) {
+		if ($timezone !== NULL)
 			$this->_timezone = $timezone;
 	}
 
@@ -119,8 +119,8 @@ 
 	 * @param string $extra_join_sql
 	 * @return string
 	 */
-	protected function _left_join($other_table,$other_table_alias,$other_table_column,$this_table_alias,$this_table_join_column, $extra_join_sql = ''){
-		return " LEFT JOIN ".$other_table." AS ".$other_table_alias. " ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column. ($extra_join_sql ? " AND $extra_join_sql" : '');
+	protected function _left_join($other_table, $other_table_alias, $other_table_column, $this_table_alias, $this_table_join_column, $extra_join_sql = '') {
+		return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
 	}
 
 
@@ -136,13 +136,13 @@ 
 	 * @param boolean $values_already_prepared_by_model_object @deprecated since 4.8.1
 	 * @return EE_Base_Class[]
 	 */
-	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' );
+	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');
 		}
 		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
 		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name().".".$this->get_this_model()->get_primary_key_field()->get_name();
-		$model_object_id = $this->_get_model_object_id( $model_object_or_id );
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
 		$query_params[0][$query_param_where_this_model_pk] = $model_object_id;
 		return $this->get_other_model()->get_all($query_params);
 	}
@@ -154,9 +154,9 @@ 
 	 * @param string $query_params
 	 * @return string
 	 */
-	protected function _disable_default_where_conditions_on_query_param($query_params){
-		if( ! isset($query_params['default_where_conditions'])){
-			$query_params['default_where_conditions']='none';
+	protected function _disable_default_where_conditions_on_query_param($query_params) {
+		if ( ! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
 		}
 		return $query_params;
 	}
@@ -172,15 +172,15 @@ 
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
-	public function delete_all_related($model_object_or_id,$query_params = array()){
+	public function delete_all_related($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deletedx
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( ! $delete_is_blocked ){
+			if ( ! $delete_is_blocked) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$related_model_object->delete();
 				$deleted_count++;
@@ -200,27 +200,27 @@ 
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
-	public function delete_related_permanently($model_object_or_id,$query_params = array()){
+	public function delete_related_permanently($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deletedx
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( $related_model_object instanceof EE_Soft_Delete_Base_Class ){
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$deleted_count++;
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$related_model_object->delete_permanently();
-				}else{
+				} else {
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else {
 				//its not a soft-deletable thing anyways. do the normal logic.
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
 					$related_model_object->delete();
 					$deleted_count++;
@@ -239,13 +239,13 @@ 
 	 * @return int
 	 */
 	protected function _get_model_object_id($model_object_or_id) {
-		if($model_object_or_id instanceof EE_Base_Class){
+		if ($model_object_or_id instanceof EE_Base_Class) {
 			$model_object_id = $model_object_or_id->ID();
-		}else{
+		} else {
 			$model_object_id = $model_object_or_id;
 		}
-		if( ! $model_object_id){
-			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"),$this->get_other_model()->get_this_model_name(),$this->get_this_model()->get_this_model_name()));
+		if ( ! $model_object_id) {
+			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"), $this->get_other_model()->get_this_model_name(), $this->get_this_model()->get_this_model_name()));
 		}
 		return $model_object_id;
 	}
@@ -288,10 +288,10 @@ 
 	 * @param array $where_query_param  like EEM_Base::get_all's $query_params[0] (where conditions)
 	 * @return EE_Base_Class[]
 	 */
-	public function remove_relations($this_obj_or_id,$where_query_param = array()){
-		$related_things = $this->get_all_related($this_obj_or_id,array($where_query_param));
+	public function remove_relations($this_obj_or_id, $where_query_param = array()) {
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
 		$objs_removed = array();
-		foreach($related_things as $related_thing){
+		foreach ($related_things as $related_thing) {
 			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
 		}
 		return $objs_removed;
@@ -304,7 +304,7 @@ 
 	 * related objects exist, returns false.
 	 * @return boolean
 	 */
-	public function block_delete_if_related_models_exist(){
+	public function block_delete_if_related_models_exist() {
 		return $this->_blocking_delete;
 	}
 
@@ -313,13 +313,13 @@ 
 	 * Gets the error message to show
 	 * @return string
 	 */
-	public function get_deletion_error_message(){
-		if($this->_blocking_delete_error_message){
+	public function get_deletion_error_message() {
+		if ($this->_blocking_delete_error_message) {
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else {
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
-				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
+				__('This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
 				$this->get_this_model()->item_name(1),
 				$this->get_other_model()->item_name(1),
 				$this->get_other_model()->item_name(2)

Doc Comments +4 added lines, -4 removed lines

@@ -112,9 +112,9 @@ 
 
 	/**
 	 * @param        $other_table
-	 * @param        $other_table_alias
+	 * @param        string $other_table_alias
 	 * @param        $other_table_column
-	 * @param        $this_table_alias
+	 * @param        string $this_table_alias
 	 * @param        $this_table_join_column
 	 * @param string $extra_join_sql
 	 * @return string
@@ -168,7 +168,7 @@ 
 	 * parameters are specified, then all related model objects will be deleted.
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class $model_object_or_id
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
@@ -196,7 +196,7 @@ 
 	 * parameters are specified, then all related model objects will be deleted.
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class $model_object_or_id
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */