eventespresso / event-espresso-core

core/db_models/relations/EE_Belongs_To_Any_Relation.php

Indentation +73 added lines, -73 removed lines

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

Spacing +4 added lines, -4 removed lines

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

core/db_models/relations/EE_HABTM_Relation.php

Indentation +199 added lines, -199 removed lines

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

Spacing +13 added lines, -13 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-require_once(EE_MODELS . 'relations/EE_Model_Relation_Base.php');
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
 
 
 /**
@@ -68,18 +68,18 @@ 
         //remember the model relation chain to the JOIN model, because we'll
         //need it for get_join_statement()
         $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
+        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field(); //get_foreign_key_to($this->get_other_model()->get_this_model_name());
         $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
         $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+                $this->get_this_model()->get_this_model_name()).$this_table_pk_field->get_table_alias();
 
         $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+                $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
         $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
         //phew! ok, we have all the info we need, now we can create the SQL join string
         $SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(),
                 $this_table_alias,
-                $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+                $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
         return $SQL;
     }
@@ -104,16 +104,16 @@ 
         }
         $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
         $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model,
-                $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+                $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
         $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
         $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
         $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
+                $this->get_other_model()->get_this_model_name()).$other_table_pk_field->get_table_alias();
         $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
         $SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
                 $join_table_alias,
-                $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+                $join_table_fk_field_to_other_table->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
         return $SQL;
     }
 
@@ -146,12 +146,12 @@ 
         );
 
         //if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
+        if ( ! empty($extra_join_model_fields_n_values)) {
             //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             //make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
+                $query_param                = str_replace($this->get_join_model()->get_this_model_name().".", "",
                     $query_param);
                 $parsed_query[$query_param] = $val;
             }
@@ -165,7 +165,7 @@ 
         //if there is already an entry in the join table, indicating a relationship, we're done
         //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
         //the other tables, use the joining model directly!
-        if (! $existing_entry_in_join_table) {
+        if ( ! $existing_entry_in_join_table) {
             $this->get_join_model()->insert($cols_n_values);
         }
         return $other_model_obj;
@@ -196,12 +196,12 @@ 
         );
 
         //if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
+        if ( ! empty($where_query)) {
             //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             //make sure we strip THIS models name from the query param
             $parsed_query = array();
             foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
+                $query_param                = str_replace($this->get_join_model()->get_this_model_name().".", "",
                     $query_param);
                 $parsed_query[$query_param] = $val;
             }

core/db_models/relations/EE_Belongs_To_Relation.php

Indentation +113 added lines, -113 removed lines

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

Spacing +4 added lines, -4 removed lines

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

core/db_models/fields/EE_Datetime_Field.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +742 added lines, -742 removed lines

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

Spacing +11 added lines, -11 removed lines

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

core/business/EE_Transaction_Processor.class.php

Doc Comments +1 added lines

@@ -187,6 +187,7 @@
      *                                                         when retrieving cached registrations from a transaction
      * @param bool $trigger_notifications                      whether or not to call
      *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+     * @param EE_Payment $payment
      * @return array
      * @throws \EE_Error
      */

Indentation +45 added lines, -46 removed lines

@@ -7,8 +7,7 @@ 
  * the interaction of EE_Transaction and EE_Registration model objects
  * Provides methods for manipulating and processing changes to an EE_Transaction
  * and it's related EE_Registrations with regards to the checkout/registration process
-
-*
+ *
 *@package     Event Espresso
  * @subpackage 	core
  * @author      Brent Christensen
@@ -177,24 +176,24 @@ 
 
 
 
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool $trigger_notifications                      whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool $trigger_notifications                      whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_and_registrations_after_checkout_or_payment(
 		EE_Transaction $transaction,
 		$payment = null,
 		$registration_query_params = array(),
-        $trigger_notifications = true
+		$trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
 		$this->_set_registration_query_params( $registration_query_params );
@@ -224,15 +223,15 @@ 
 			$update_params
 		);
 		if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
 			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
 			$transaction,
 			$update_params
@@ -242,17 +241,17 @@ 
 
 
 
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_after_reinstating_canceled_registration(
 		EE_Registration $registration,
 		$closed_reg_statuses = array(),
@@ -314,15 +313,15 @@ 
 		try {
 			$transaction = $this->get_transaction_for_registration( $registration );
 			if (
-			    apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			){
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
+				EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
 			}
 		} catch ( EE_Error $e ) {
 			EE_Error::add_error(
@@ -532,7 +531,7 @@ 
 						foreach ( $available_payment_methods as $available_payment_method ) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
-							    && $available_payment_method->open_by_default()
+								&& $available_payment_method->open_by_default()
 							) {
 								$PMD_ID = $available_payment_method->ID();
 								break;

Spacing +86 added lines, -86 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Processor
@@ -50,10 +50,10 @@ 
 	 * @param array $registration_query_params
 	 *@return EE_Transaction_Processor instance
 	 */
-	public static function instance( $registration_query_params = array() ) {
+	public static function instance($registration_query_params = array()) {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Processor ) {
-			self::$_instance = new self( $registration_query_params );
+		if ( ! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
 		}
 		return self::$_instance;
 	}
@@ -63,9 +63,9 @@ 
 	/**
 	 * @param array $registration_query_params
 	 */
-	private function __construct( $registration_query_params = array() ) {
+	private function __construct($registration_query_params = array()) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 	}
 
 
@@ -74,8 +74,8 @@ 
 	 * @access private
 	 * @param array $registration_query_params
 	 */
-	private function _set_registration_query_params( $registration_query_params ) {
-		$this->_registration_query_params = ! empty( $registration_query_params ) ? $registration_query_params : array( 'order_by' => array( 'REG_count' => 'ASC' ));
+	private function _set_registration_query_params($registration_query_params) {
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params : array('order_by' => array('REG_count' => 'ASC'));
 	}
 
 
@@ -104,10 +104,10 @@ 
 		);
 		// send messages
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		$registration_processor->trigger_registration_update_notifications(
 			$transaction->primary_registration(),
-			array( 'manually_updated' 	=> true )
+			array('manually_updated' 	=> true)
 		);
 		do_action(
 			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
@@ -197,13 +197,13 @@ 
         $trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// get final reg step status
 		$finalized = $transaction->final_reg_step_completed();
 		// if the 'finalize_registration' step has been initiated (has a timestamp)
 		// but has not yet been fully completed (TRUE)
-		if ( is_int( $finalized ) && $finalized !== false && $finalized !== true ) {
-			$transaction->set_reg_step_completed( 'finalize_registration' );
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
 			$finalized = true;
 		}
 		$transaction->save();
@@ -259,22 +259,22 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
 				$transaction,
 				$registration
 			);
 			// un-cancel the ticket
-			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item( $ticket_line_item );
-		} catch ( EE_Error $e ) {
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -283,7 +283,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? $success : false;
 		}
 		return $success;
@@ -307,12 +307,12 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( ! in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			if (
 			    apply_filters(
                     'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
@@ -320,14 +320,14 @@ 
                     $registration,
                     $transaction
                 )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+            ) {
+                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration($transaction, $registration);
+                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
 			}
-		} catch ( EE_Error $e ) {
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -336,7 +336,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -352,12 +352,12 @@ 
 	 * @return 	EE_Transaction
 	 * @throws 	EE_Error
 	 */
-	public function get_transaction_for_registration( EE_Registration $registration ) {
+	public function get_transaction_for_registration(EE_Registration $registration) {
 		$transaction = $registration->transaction();
-		if ( ! $transaction instanceof EE_Transaction ) {
+		if ( ! $transaction instanceof EE_Transaction) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso' ),
+					__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
 					$registration->ID()
 				)
 			);
@@ -380,16 +380,16 @@ 
 		EE_Transaction $transaction,
 		EE_Registration $registration
 	) {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
+		EE_Registry::instance()->load_helper('Line_Item');
 		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
 			$transaction->ID(),
 			$registration->ticket_ID()
 		);
-		if ( ! $ticket_line_item instanceof EE_Line_Item ) {
+		if ( ! $ticket_line_item instanceof EE_Line_Item) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-						'event_espresso' ),
+					__('The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'),
 					$transaction->ID(),
 					$registration->ticket_ID()
 				)
@@ -422,22 +422,22 @@ 
 		$update_txn = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
 			if (
 				$registration instanceof EE_Registration
-				&& ! in_array( $registration->status_ID(), $closed_reg_statuses )
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
 			) {
 				return false;
 			}
 		}
-		if ( in_array( $new_TXN_status, EEM_Transaction::txn_status_array() ) ) {
-			$transaction->set_status( $new_TXN_status );
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -466,22 +466,22 @@ 
 	) {
 		$response = false;
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// check that method exists
-		if ( ! method_exists( $registration_processor, $method_name )) {
-			throw new EE_Error( __( 'Method does not exist.', 'event_espresso' ));
+		if ( ! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(__('Method does not exist.', 'event_espresso'));
 		}
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
-				if ( $additional_param ) {
-					$response = $registration_processor->{$method_name}( $registration, $additional_param )
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
 						? true
 						: $response;
 				} else {
-					$response = $registration_processor->{$method_name}( $registration )
+					$response = $registration_processor->{$method_name}($registration)
 						? true
 						: $response;
 				}
@@ -508,28 +508,28 @@ 
 	public function set_transaction_payment_method_based_on_registration_statuses(
 		EE_Registration $edited_registration
 	) {
-		if ( $edited_registration instanceof EE_Registration ) {
+		if ($edited_registration instanceof EE_Registration) {
 			$transaction = $edited_registration->transaction();
-			if ( $transaction instanceof EE_Transaction ) {
+			if ($transaction instanceof EE_Transaction) {
 				$all_not_approved = true;
-				foreach ( $transaction->registrations() as $registration ) {
-					if ( $registration instanceof EE_Registration ) {
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
 						// if any REG != "Not Approved" then toggle to false
 						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
 					}
 				}
 				// if ALL Registrations are "Not Approved"
-				if ( $all_not_approved ) {
-					$transaction->set_payment_method_ID( null );
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
 					$transaction->save();
 				} else {
 					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
 						$transaction,
 						EEM_Payment_Method::scope_cart
 					);
-					if ( ! empty( $available_payment_methods ) ) {
+					if ( ! empty($available_payment_methods)) {
 						$PMD_ID = 0;
-						foreach ( $available_payment_methods as $available_payment_method ) {
+						foreach ($available_payment_methods as $available_payment_method) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
 							    && $available_payment_method->open_by_default()
@@ -538,22 +538,22 @@ 
 								break;
 							}
 						}
-						if ( ! $PMD_ID ) {
-							$first_payment_method = reset( $available_payment_methods );
-							if ( $first_payment_method instanceof EE_Payment_Method ) {
+						if ( ! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
 								$PMD_ID = $first_payment_method->ID();
 							} else {
 								EE_Error::add_error(
-									__( 'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso' ),
+									__('A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso'),
 									__FILE__, __LINE__, __FUNCTION__
 								);
 							}
 						}
-						$transaction->set_payment_method_ID( $PMD_ID );
+						$transaction->set_payment_method_ID($PMD_ID);
 						$transaction->save();
 					} else {
 						EE_Error::add_error(
-							__( 'Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso' ),
+							__('Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso'),
 							__FILE__, __LINE__, __FUNCTION__
 						);
 					}
@@ -590,7 +590,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -600,7 +600,7 @@ 
 			'4.9.12'
 		);
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -629,7 +629,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -673,7 +673,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -700,7 +700,7 @@ 
 	 * @param string         $exception
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except( EE_Transaction $transaction, $exception = '' ) {
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '') {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -710,7 +710,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->all_reg_steps_completed_except( $exception );
+		return $transaction->all_reg_steps_completed_except($exception);
 	}
 
 
@@ -726,7 +726,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except_final_step( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -753,7 +753,7 @@ 
 	 * @param string         $reg_step_slug
 	 * @return boolean | int
 	 */
-	public function reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -763,7 +763,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->reg_step_completed( $reg_step_slug );
+		return $transaction->reg_step_completed($reg_step_slug);
 	}
 
 
@@ -779,7 +779,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean | int
 	 */
-	public function final_reg_step_completed( EE_Transaction $transaction ) {
+	public function final_reg_step_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -805,7 +805,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_initiated( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -815,7 +815,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_initiated( $reg_step_slug );
+		return $transaction->set_reg_step_initiated($reg_step_slug);
 	}
 
 
@@ -831,7 +831,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -841,7 +841,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_completed( $reg_step_slug );
+		return $transaction->set_reg_step_completed($reg_step_slug);
 	}
 
 
@@ -857,7 +857,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_not_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -867,7 +867,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_not_completed( $reg_step_slug );
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
 	}
 
 
@@ -884,7 +884,7 @@ 
 	 * @param string          $reg_step_slug
 	 * @return void
 	 */
-	public function remove_reg_step( EE_Transaction $transaction, $reg_step_slug ) {
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -894,7 +894,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		$transaction->remove_reg_step( $reg_step_slug );
+		$transaction->remove_reg_step($reg_step_slug);
 	}
 
 
@@ -910,7 +910,7 @@ 
 	 * @return    boolean
 	 * @throws \EE_Error
 	 */
-	public function toggle_failed_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_failed_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -934,7 +934,7 @@ 
 	 * @param  EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function toggle_abandoned_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(

modules/single_page_checkout/reg_steps/finalize_registration/EE_SPCO_Reg_Step_Finalize_Registration.class.php

Indentation +70 added lines, -70 removed lines

@@ -56,10 +56,10 @@ 
 
 
 
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function generate_reg_form() {
 		// create empty form so that things don't break
 		$this->reg_form = new EE_Form_Section_Proper();
@@ -68,26 +68,26 @@ 
 
 
 
-    /**
-     * @return boolean
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * @return boolean
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	public function process_reg_step() {
-        // ensure all data gets refreshed from the db
+		// ensure all data gets refreshed from the db
 		$this->checkout->refresh_all_entities( true );
 		// ensures that all details and statuses for transaction, registration, and payments are updated
 		$txn_update_params = $this->_finalize_transaction();
-        // maybe send messages
-        $this->_set_notification_triggers();
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $this->checkout->transaction->primary_registration(),
-            $txn_update_params
-        );
-        // set a hook point
+		// maybe send messages
+		$this->_set_notification_triggers();
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$this->checkout->transaction->primary_registration(),
+			$txn_update_params
+		);
+		// set a hook point
 		do_action(
 			'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
 			$this->checkout,
@@ -104,7 +104,7 @@ 
 		if (
 			! (
 				$this->checkout->payment_method instanceof EE_Payment_Method
-		        && $this->checkout->payment_method->is_off_site()
+				&& $this->checkout->payment_method->is_off_site()
 			)
 		) {
 			// mark this reg step as completed
@@ -116,14 +116,14 @@ 
 
 
 
-    /**
-     * _finalize_transaction
-     * ensures that all details and statuses for transaction, registration, and payments are updated
-     *
-     * @return array
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * _finalize_transaction
+	 * ensures that all details and statuses for transaction, registration, and payments are updated
+	 *
+	 * @return array
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	protected function _finalize_transaction() {
 		/** @type EE_Transaction_Processor $transaction_processor */
 		$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
@@ -139,17 +139,17 @@ 
 		}
 		// maybe update status, but don't save transaction just yet
 		$this->checkout->transaction->update_status_based_on_total_paid( false );
-        // this will result in the base session properties getting saved to the TXN_Session_data field
+		// this will result in the base session properties getting saved to the TXN_Session_data field
 		$this->checkout->transaction->set_txn_session_data(
 			EE_Registry::instance()->SSN->get_session_data( null, true )
 		);
-        // update the TXN if payment conditions have changed, but do NOT trigger notifications,
-        // because we will do that in process_reg_step() after setting some more triggers
+		// update the TXN if payment conditions have changed, but do NOT trigger notifications,
+		// because we will do that in process_reg_step() after setting some more triggers
 		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
 			$this->checkout->transaction,
 			$this->checkout->payment,
 			$this->checkout->reg_cache_where_params,
-            false
+			false
 		);
 	}
 
@@ -167,43 +167,43 @@ 
 	protected function _set_notification_triggers() {
 
 		if ( $this->checkout->payment_method instanceof EE_Payment_Method ) {
-		    // let's start with the assumption that we need to trigger notifications
-            // then toggle this to false for conditions where we know we don't need to
-		    $deliver_notifications = true;
-            if (
-                // if SPCO revisit
-                filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
-                // and TXN or REG statuses have NOT changed due to a payment
-                && ! (
-                    $this->checkout->transaction->txn_status_updated()
-                    || $this->checkout->any_reg_status_updated()
-                )
-            ) {
-                $deliver_notifications = false;
-            }
-            if ($this->checkout->payment_method->is_off_site()) {
-                /** @var EE_Gateway $gateway */
-                $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-                // and the gateway uses a separate request to process the IPN
-                if (
-                    $gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
-                ) {
-                    // IPN request will handle triggering notifications
-                    $deliver_notifications = false;
-                    // no really... don't send any notices in this request
-                    remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
-                    add_filter(
-                        'FHEE__EED_Messages___maybe_registration__deliver_notifications',
-                        '__return_false',
-                        15
-                    );
-                }
-            }
-            if ($deliver_notifications) {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
+			// let's start with the assumption that we need to trigger notifications
+			// then toggle this to false for conditions where we know we don't need to
+			$deliver_notifications = true;
+			if (
+				// if SPCO revisit
+				filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
+				// and TXN or REG statuses have NOT changed due to a payment
+				&& ! (
+					$this->checkout->transaction->txn_status_updated()
+					|| $this->checkout->any_reg_status_updated()
+				)
+			) {
+				$deliver_notifications = false;
+			}
+			if ($this->checkout->payment_method->is_off_site()) {
+				/** @var EE_Gateway $gateway */
+				$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+				// and the gateway uses a separate request to process the IPN
+				if (
+					$gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
+				) {
+					// IPN request will handle triggering notifications
+					$deliver_notifications = false;
+					// no really... don't send any notices in this request
+					remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
+					add_filter(
+						'FHEE__EED_Messages___maybe_registration__deliver_notifications',
+						'__return_false',
+						15
+					);
+				}
+			}
+			if ($deliver_notifications) {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
 		}
 	}
 

Spacing +18 added lines, -18 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -21,9 +21,9 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'finalize_registration';
-		$this->_name = __( 'Finalize Registration', 'event_espresso' );
+		$this->_name = __('Finalize Registration', 'event_espresso');
 		$this->_submit_button_text = $this->_name;
 		$this->_template = '';
 		$this->checkout = $checkout;
@@ -46,7 +46,7 @@ 
 	 */
 	public function initialize_reg_step() {
 		// there's actually no reg form to process if this is the final step
-		if ( $this->is_current_step() ) {
+		if ($this->is_current_step()) {
 			$this->checkout->step = $_REQUEST['step'] = $this->slug();
 			$this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
 			$this->checkout->generate_reg_form = false;
@@ -75,7 +75,7 @@ 
      */
 	public function process_reg_step() {
         // ensure all data gets refreshed from the db
-		$this->checkout->refresh_all_entities( true );
+		$this->checkout->refresh_all_entities(true);
 		// ensures that all details and statuses for transaction, registration, and payments are updated
 		$txn_update_params = $this->_finalize_transaction();
         // maybe send messages
@@ -94,13 +94,13 @@ 
 			$txn_update_params
 		);
 		// check if transaction has a primary registrant and that it has a related Attendee object
-		if ( ! $this->_validate_primary_registrant() ) {
+		if ( ! $this->_validate_primary_registrant()) {
 			return false;
 		}
 		// you don't have to go home but you can't stay here !
 		$this->checkout->redirect = true;
 		$this->checkout->continue_reg = true;
-		$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 		if (
 			! (
 				$this->checkout->payment_method instanceof EE_Payment_Method
@@ -126,22 +126,22 @@ 
      */
 	protected function _finalize_transaction() {
 		/** @type EE_Transaction_Processor $transaction_processor */
-		$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
 		//set revisit flag in txn processor
-		$transaction_processor->set_revisit( $this->checkout->revisit );
+		$transaction_processor->set_revisit($this->checkout->revisit);
 		// at this point we'll consider a TXN to not have been abandoned
 		$this->checkout->transaction->toggle_abandoned_transaction_status();
-		if ( $this->checkout->cart instanceof EE_Cart ) {
+		if ($this->checkout->cart instanceof EE_Cart) {
 			// save TXN data to the cart
 			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
 				$this->checkout->transaction->ID()
 			);
 		}
 		// maybe update status, but don't save transaction just yet
-		$this->checkout->transaction->update_status_based_on_total_paid( false );
+		$this->checkout->transaction->update_status_based_on_total_paid(false);
         // this will result in the base session properties getting saved to the TXN_Session_data field
 		$this->checkout->transaction->set_txn_session_data(
-			EE_Registry::instance()->SSN->get_session_data( null, true )
+			EE_Registry::instance()->SSN->get_session_data(null, true)
 		);
         // update the TXN if payment conditions have changed, but do NOT trigger notifications,
         // because we will do that in process_reg_step() after setting some more triggers
@@ -166,7 +166,7 @@ 
 	 */
 	protected function _set_notification_triggers() {
 
-		if ( $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ($this->checkout->payment_method instanceof EE_Payment_Method) {
 		    // let's start with the assumption that we need to trigger notifications
             // then toggle this to false for conditions where we know we don't need to
 		    $deliver_notifications = true;
@@ -216,9 +216,9 @@ 
 	 * @throws \EE_Error
 	 */
 	protected function _validate_primary_registrant() {
-		if ( ! $this->checkout->transaction_has_primary_registrant() ) {
+		if ( ! $this->checkout->transaction_has_primary_registrant()) {
 			EE_Error::add_error(
-				__( 'A valid Primary Registration for this Transaction could not be found.', 'event_espresso' ),
+				__('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -229,7 +229,7 @@ 
 		}
 		// setup URL for redirect
 		$this->checkout->redirect_url = add_query_arg(
-			array( 'e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link() ),
+			array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
 			$this->checkout->thank_you_page_url
 		);
 		return true;
@@ -242,7 +242,7 @@ 
 	 */
 	public function update_reg_step() {
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FILE__,
+			__CLASS__.'::'.__FILE__,
 			__(
 				'Can not call update_reg_step() on the Finalize Registration reg step.',
 				'event_espresso'

core/db_models/fields/EE_Primary_Key_String_Field.php

Indentation +17 added lines, -17 removed lines

@@ -4,22 +4,22 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags($value_inputted_for_field_on_model_object);
+	}
 }
\ No newline at end of file

Doc Comments +3 added lines

@@ -4,6 +4,9 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
+    /**
+     * @param string $table_column
+     */
     public function __construct($table_column, $nicename)
     {
         parent::__construct($table_column, $nicename, null);

core/db_models/fields/EE_All_Caps_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
  */
 class EE_All_Caps_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * makes it all upper case, and key-like
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * makes it all upper case, and key-like
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

modules/single_page_checkout/reg_steps/attendee_information/attendee_info_main.template.php

Spacing +15 added lines, -15 removed lines

@@ -4,7 +4,7 @@ 
 /** @var string $default_hidden_inputs */
 ?>
 	<p id="spco-attendee_information-pg" class="spco-steps-pg small-text drk-grey-text">
-		<?php echo apply_filters( 'FHEE__registration_page_attendee_information__attendee_information_pg', sprintf( __('In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.', 'event_espresso'), '<br />', '<span class="asterisk">*</span>' )); ?>
+		<?php echo apply_filters('FHEE__registration_page_attendee_information__attendee_information_pg', sprintf(__('In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.', 'event_espresso'), '<br />', '<span class="asterisk">*</span>')); ?>
 	</p>
 
 <?php
@@ -12,34 +12,34 @@ 
 $prev_event = 0;
 $prev_ticket = 0;
 
-if ( count( $registrations ) > 0 ) {
-	foreach ( $registrations as $registration ) {
-		if ( $registration instanceof EE_Registration ) {
+if (count($registrations) > 0) {
+	foreach ($registrations as $registration) {
+		if ($registration instanceof EE_Registration) {
 			$att_nmbr++;
 ?>
 
-		<div id="spco-attendee-panel-dv-<?php echo $registration->reg_url_link();?>" class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $registration->ticket()->ID();?>">
+		<div id="spco-attendee-panel-dv-<?php echo $registration->reg_url_link(); ?>" class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $registration->ticket()->ID(); ?>">
 
-			<?php if ( $registration->event()->ID() !== $prev_event ) { ?>
+			<?php if ($registration->event()->ID() !== $prev_event) { ?>
 			<h4 id="event_title-<?php echo $registration->event()->ID() ?>" class="big-event-title-hdr">
 				<?php echo $registration->event()->name(); ?>
 			</h4>
 			<?php } ?>
-			<?php if ( $registration->ticket()->ID() !== $prev_ticket ) { ?>
-				<?php if ( ! $revisit ) { ?>
+			<?php if ($registration->ticket()->ID() !== $prev_ticket) { ?>
+				<?php if ( ! $revisit) { ?>
 			<div class="spco-ticket-info-dv small-text">
-				<h5><?php _e('Details', 'event_espresso');?></h5>
+				<h5><?php _e('Details', 'event_espresso'); ?></h5>
 				<table>
 					<thead>
 						<tr>
-							<th scope="col" width=""><?php _e('Name and Description', 'event_espresso');?></th>
-							<th scope="col" width="7.5%" class="jst-rght"><?php _e('Qty', 'event_espresso');?></th>
-							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Price', 'event_espresso');?></th>
-							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Total', 'event_espresso');?></th>
+							<th scope="col" width=""><?php _e('Name and Description', 'event_espresso'); ?></th>
+							<th scope="col" width="7.5%" class="jst-rght"><?php _e('Qty', 'event_espresso'); ?></th>
+							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Price', 'event_espresso'); ?></th>
+							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Total', 'event_espresso'); ?></th>
 						</tr>
 					</thead>
 					<tbody>
-					<?php echo $ticket_line_item[ $registration->ticket()->ID() ]; ?>
+					<?php echo $ticket_line_item[$registration->ticket()->ID()]; ?>
 					</tbody>
 				</table>
 			</div>
@@ -48,7 +48,7 @@ 
 
 			<?php
 			// ATTENDEE QUESTIONS
-			$reg_form = EE_Template_Layout::get_subform_name( $registration->reg_url_link() );
+			$reg_form = EE_Template_Layout::get_subform_name($registration->reg_url_link());
 			echo ${$reg_form};
 			?>