eventespresso / event-espresso-core

core/db_models/relations/EE_Model_Relation_Base.php

Spacing +7 added lines, -7 removed lines

@@ -156,7 +156,7 @@ 
         $this_table_join_column,
         $extra_join_sql = ''
     ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+        return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
     }
 
 
@@ -190,7 +190,7 @@ 
                                                              . "."
                                                              . $this->get_this_model()->get_primary_key_field()->get_name();
         $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+        $query_params[0][$query_param_where_this_model_pk] = $model_object_id;
         return $this->get_other_model()->get_all($query_params);
     }
 
@@ -203,7 +203,7 @@ 
      */
     protected function _disable_default_where_conditions_on_query_param($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'none';
         }
         return $query_params;
@@ -233,7 +233,7 @@ 
                 $model_object_or_id
             );
             /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
+            if ( ! $delete_is_blocked) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $related_model_object->delete();
                 $deleted_count++;
@@ -269,7 +269,7 @@ 
             if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $deleted_count++;
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $related_model_object->delete_permanently();
                 } else {
                     // delete is blocked
@@ -278,7 +278,7 @@ 
                 }
             } else {
                 // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $this->remove_relation_to($model_object_or_id, $related_model_object);
                     $related_model_object->delete();
                     $deleted_count++;
@@ -302,7 +302,7 @@ 
         if ($model_object_or_id instanceof EE_Base_Class) {
             $model_object_id = $model_object_or_id->ID();
         }
-        if (! $model_object_id) {
+        if ( ! $model_object_id) {
             throw new EE_Error(sprintf(
                 __(
                     "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",

Indentation +497 added lines, -497 removed lines

@@ -15,502 +15,502 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_this_model_name;
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_other_model_name;
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected $_blocking_delete_error_message;
-
-    protected $_blocking_delete = false;
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes, $blocking_delete_error_message)
-    {
-        $this->_blocking_delete               = $block_deletes;
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     * @throws EE_Error
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-        if (is_string($this->_blocking_delete)) {
-            throw new EE_Error(sprintf(
-                __(
-                    "When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $this_model_name,
-                $other_model_name,
-                $this->_blocking_delete
-            ));
-        }
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     */
-    public function get_this_model()
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     */
-    public function get_other_model()
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        $modelInstance->set_timezone($this->_timezone);
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string $timezone timezone to set.
-     */
-    public function set_timezone($timezone)
-    {
-        if ($timezone !== null) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param        $other_table
-     * @param        $other_table_alias
-     * @param        $other_table_column
-     * @param        $this_table_alias
-     * @param        $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        $other_table,
-        $other_table_alias,
-        $other_table_column,
-        $this_table_alias,
-        $this_table_join_column,
-        $extra_join_sql = ''
-    ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
-     * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                __('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1'
-            );
-        }
-        $query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
-        $query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
-                                                             . "."
-                                                             . $this->get_this_model()->get_primary_key_field()->get_name();
-        $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param string $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_all_related($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
-     * @throws EE_Error
-     * @return int
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(sprintf(
-                __(
-                    "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                    "event_espresso"
-                ),
-                $this->get_other_model()->get_this_model_name(),
-                $this->get_this_model()->get_this_model_name()
-            ));
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement($model_relation_chain);
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $extra_join_model_fields_n_values
-     * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        $extra_join_model_fields_n_values = array()
-    );
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $where_query
-     * @return bool
-     */
-    abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function remove_relations($this_obj_or_id, $where_query_param = array())
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
-        $objs_removed   = array();
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist()
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     */
-    public function get_deletion_error_message()
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_this_model_name;
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_other_model_name;
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected $_blocking_delete_error_message;
+
+	protected $_blocking_delete = false;
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes, $blocking_delete_error_message)
+	{
+		$this->_blocking_delete               = $block_deletes;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+		if (is_string($this->_blocking_delete)) {
+			throw new EE_Error(sprintf(
+				__(
+					"When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
+					"event_espresso"
+				),
+				get_class($this),
+				$this_model_name,
+				$other_model_name,
+				$this->_blocking_delete
+			));
+		}
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_this_model()
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_other_model()
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string $timezone timezone to set.
+	 */
+	public function set_timezone($timezone)
+	{
+		if ($timezone !== null) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param        $other_table
+	 * @param        $other_table_alias
+	 * @param        $other_table_column
+	 * @param        $this_table_alias
+	 * @param        $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		$other_table,
+		$other_table_alias,
+		$other_table_column,
+		$this_table_alias,
+		$this_table_join_column,
+		$extra_join_sql = ''
+	) {
+		return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
+	 * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1'
+			);
+		}
+		$query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
+		$query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
+															 . "."
+															 . $this->get_this_model()->get_primary_key_field()->get_name();
+		$model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param string $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_all_related($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
+	 * @throws EE_Error
+	 * @return int
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(sprintf(
+				__(
+					"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+					"event_espresso"
+				),
+				$this->get_other_model()->get_this_model_name(),
+				$this->get_this_model()->get_this_model_name()
+			));
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement($model_relation_chain);
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		$extra_join_model_fields_n_values = array()
+	);
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $where_query
+	 * @return bool
+	 */
+	abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function remove_relations($this_obj_or_id, $where_query_param = array())
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
+		$objs_removed   = array();
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist()
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 */
+	public function get_deletion_error_message()
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                __(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(1),
-                $this->get_other_model()->item_name(1),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return true;
-    }
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'relation' => true,
-            'relation_type' => get_class($this),
-            'readonly' => $this->getSchemaReadonly()
-        );
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = array(
-                'type' => 'object'
-            );
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(1),
+				$this->get_other_model()->item_name(1),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return true;
+	}
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'relation' => true,
+			'relation_type' => get_class($this),
+			'readonly' => $this->getSchemaReadonly()
+		);
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = array(
+				'type' => 'object'
+			);
+		}
+
+		return $schema;
+	}
 }

core/db_models/relations/EE_Has_Many_Revision_Relation.php

Spacing +7 added lines, -7 removed lines

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

Indentation +296 added lines, -296 removed lines

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

core/db_models/relations/EE_Has_Many_Any_Relation.php

Indentation +84 added lines, -84 removed lines

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

Spacing +4 added lines, -4 removed lines

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

core/db_models/EEM_Status.model.php

Indentation +277 added lines, -277 removed lines

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

Spacing +9 added lines, -9 removed lines

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

core/db_models/helpers/EE_Unique_Index.php

Indentation +1 added lines, -1 removed lines

@@ -6,5 +6,5 @@
  */
 class EE_Unique_Index extends EE_Index
 {
-    // yep, actually the same as index right now
+	// yep, actually the same as index right now
 }

core/db_models/helpers/EE_Primary_Key_Index.php

Indentation +1 added lines, -1 removed lines

@@ -6,5 +6,5 @@
  */
 class EE_Primary_Key_Index extends EE_Unique_Index
 {
-    // yep, actually the same as unique index right now
+	// yep, actually the same as unique index right now
 }

core/db_models/helpers/EE_Model_Query_Info_Carrier.php

Indentation +90 added lines, -90 removed lines

@@ -14,141 +14,141 @@ 
    /**
     * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
     */
-    private $_join_sql;
+	private $_join_sql;
    /**
     *
     * @var array stating all the models that have been included thus far,so we don't get duplicates.
     * Keys are the model relation chains to them from the queried model
     * (eg, "Registration.Transaction.Payment"), and valuesare model names (eg "Payment")
     */
-    private $_models_included;
+	private $_models_included;
    
    /**
     * After we've acquired all the data types, we can create this sql.
     * @var string
     */
-    private $_where_sql;
+	private $_where_sql;
    /**
     * Full join sql. Eg, in a select query, that's everything after the "FROM", and before the "WHERE", so it includes
     * the declaration of the main model's tables, and then appends all the joining sql to other models
     * @var string
     */
-    private $_main_join_sql;
+	private $_main_join_sql;
    
    
-    private $_limit_sql;
+	private $_limit_sql;
    
-    private $_order_by_sql;
+	private $_order_by_sql;
    
-    private $_having_sql;
+	private $_having_sql;
    
-    private $_group_by_sql;
+	private $_group_by_sql;
    
-    public function set_limit_sql($limit_sql)
-    {
-        $this->_limit_sql = $limit_sql;
-    }
+	public function set_limit_sql($limit_sql)
+	{
+		$this->_limit_sql = $limit_sql;
+	}
     
-    public function set_order_by_sql($order_by_sql)
-    {
-        $this->_order_by_sql = $order_by_sql;
-    }
-    public function set_group_by_sql($group_by_sql)
-    {
-        $this->_group_by_sql = $group_by_sql;
-    }
-    public function set_having_sql($having_sql)
-    {
-        $this->_having_sql = $having_sql;
-    }
-    public function get_limit_sql()
-    {
-        return $this->_limit_sql;
-    }
-    public function get_order_by_sql()
-    {
-        return $this->_order_by_sql;
-    }
-    public function get_group_by_sql()
-    {
-        return $this->_group_by_sql;
-    }
-    public function get_having_sql()
-    {
-        return $this->_having_sql;
-    }
+	public function set_order_by_sql($order_by_sql)
+	{
+		$this->_order_by_sql = $order_by_sql;
+	}
+	public function set_group_by_sql($group_by_sql)
+	{
+		$this->_group_by_sql = $group_by_sql;
+	}
+	public function set_having_sql($having_sql)
+	{
+		$this->_having_sql = $having_sql;
+	}
+	public function get_limit_sql()
+	{
+		return $this->_limit_sql;
+	}
+	public function get_order_by_sql()
+	{
+		return $this->_order_by_sql;
+	}
+	public function get_group_by_sql()
+	{
+		return $this->_group_by_sql;
+	}
+	public function get_having_sql()
+	{
+		return $this->_having_sql;
+	}
    /**
     *
     * @param type $model_included_name
     * @param type $join_sql
     * @param type $data_types
     */
-    public function __construct($model_included_name = array(), $join_sql = '')
-    {
-        $this->_models_included = $model_included_name;
-        $this->_join_sql = $join_sql;
-    }
+	public function __construct($model_included_name = array(), $join_sql = '')
+	{
+		$this->_models_included = $model_included_name;
+		$this->_join_sql = $join_sql;
+	}
    
    /**
     * Merges info from the other EEM_Related_Model_Info_Carrier into this one.
     * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier
     */
-    public function merge($other_model_query_info_carrier)
-    {
-        if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
-            $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
-            $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
-        }
-        // otherwise don't merge our data.
-        // yes, this means that we must immediately merge any model data into our grand list
-        // as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
-        // which is carrying info from two models WHERE one is already included but the other is NOT
-    }
+	public function merge($other_model_query_info_carrier)
+	{
+		if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
+			$model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+			$this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
+			$this->_join_sql .= $other_model_query_info_carrier->_join_sql;
+		}
+		// otherwise don't merge our data.
+		// yes, this means that we must immediately merge any model data into our grand list
+		// as soon as we get some from ONE model, or else we could reject a EEM_Related_Model_Info_Carrier
+		// which is carrying info from two models WHERE one is already included but the other is NOT
+	}
    /**
     * Checks whether or not we have already included all the models mentione din $model_names on the query info varrier
     * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only
     * @return boolean
     */
-    protected function _have_already_included_one_of_these_models($model_names)
-    {
-        foreach ($this->_models_included as $model_relation_path => $model_included) {
-            if (array_key_exists($model_relation_path, $model_names)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	protected function _have_already_included_one_of_these_models($model_names)
+	{
+		foreach ($this->_models_included as $model_relation_path => $model_included) {
+			if (array_key_exists($model_relation_path, $model_names)) {
+				return true;
+			}
+		}
+		return false;
+	}
    /**
     * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details
     * @return array like EE_Model_Query_Info_Carrier::_models_included
     */
-    public function get_model_names_included()
-    {
-        return $this->_models_included;
-    }
+	public function get_model_names_included()
+	{
+		return $this->_models_included;
+	}
    /**
     * sets the $where_sql for later use from client code
     * @param string $where_sql
     */
-    public function set_where_sql($where_sql)
-    {
-        $this->_where_sql = $where_sql;
-    }
-    public function get_where_sql()
-    {
-        return $this->_where_sql;
-    }
+	public function set_where_sql($where_sql)
+	{
+		$this->_where_sql = $where_sql;
+	}
+	public function get_where_sql()
+	{
+		return $this->_where_sql;
+	}
 
    /**
     * Gets the SQL for joining the main model to other models involves in the query, which was set earlier on
     * the EE_Model_Query_info_Carrier by calling set_main_model_join_sql()
     * @return string
     */
-    public function get_main_model_join_sql()
-    {
-        return $this->_main_join_sql;
-    }
+	public function get_main_model_join_sql()
+	{
+		return $this->_main_join_sql;
+	}
 
 
    /**
@@ -158,12 +158,12 @@ 
     * after the FROM and before the WHERE.)
     * @param string $join_sql
     */
-    public function set_main_model_join_sql($join_sql)
-    {
-        $this->_main_join_sql = $join_sql;
-    }
-    public function get_full_join_sql()
-    {
-        return $this->_main_join_sql . $this->_join_sql;
-    }
+	public function set_main_model_join_sql($join_sql)
+	{
+		$this->_main_join_sql = $join_sql;
+	}
+	public function get_full_join_sql()
+	{
+		return $this->_main_join_sql . $this->_join_sql;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
     public function merge($other_model_query_info_carrier)
     {
         if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
-            $model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
+            $model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included();
             $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
             $this->_join_sql .= $other_model_query_info_carrier->_join_sql;
         }
@@ -164,6 +164,6 @@ 
     }
     public function get_full_join_sql()
     {
-        return $this->_main_join_sql . $this->_join_sql;
+        return $this->_main_join_sql.$this->_join_sql;
     }
 }

core/EE_Cart.core.php

Spacing +4 added lines, -4 removed lines

@@ -65,14 +65,14 @@ 
             self::$_instance = new self($grand_total, $session);
         }
         // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
+        if ( ! self::$_instance instanceof EE_Cart) {
             // try getting the cart out of the session
             $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
             self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
             unset($saved_cart);
         }
         // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
             self::$_instance = new self($grand_total, $session);
         }
         self::$_instance->get_grand_total();
@@ -124,7 +124,7 @@ 
      */
     public function session()
     {
-        if (! $this->_session instanceof EE_Session) {
+        if ( ! $this->_session instanceof EE_Session) {
             $this->set_session();
         }
         return $this->_session;
@@ -392,7 +392,7 @@ 
 
     public function __wakeup()
     {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+        if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
             // $this->_grand_total is actually just an ID, so use it to get the object from the db
             $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
         }

Indentation +393 added lines, -393 removed lines

@@ -17,397 +17,397 @@
 class EE_Cart implements ResettableInterface
 {
 
-    /**
-     * instance of the EE_Cart object
-     *
-     * @access    private
-     * @var EE_Cart $_instance
-     */
-    private static $_instance;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @access    protected
-     * @var EE_Session $_session
-     */
-    protected $_session;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * @var EE_Line_Item
-     */
-    private $_grand_total;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     */
-    private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws \EE_Error
-     */
-    public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-    /**
-     * @return \EE_Session
-     */
-    public function session()
-    {
-        if (! $this->_session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->_session;
-    }
-
-
-    /**
-     * @param EE_Session $session
-     */
-    public function set_session(EE_Session $session = null)
-    {
-        $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->_grand_total = $line_item;
-    }
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param EE_Session     $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    private function _create_grand_total()
-    {
-        $this->_grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->_grand_total;
-    }
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @access public
-     * @return \EE_Line_Item[]
-     */
-    public function get_tickets()
-    {
-        if ($this->_grand_total === null) {
-            return array();
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
-    }
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @access public
-     * @return int
-     * @throws \EE_Error
-     */
-    public function all_ticket_quantity_count()
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->get('LIN_quantity');
-        }
-        return $count;
-    }
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return \EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_taxes()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public function get_grand_total()
-    {
-        return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
-    }
-
-
-    /**
-     * @process items for adding to cart
-     * @access  public
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
-        return $this->save_cart() ? true : false;
-    }
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_total_before_tax()
-    {
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_applied_taxes()
-    {
-        return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_grand_total()
-    {
-        EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function recalculate_all_cart_totals()
-    {
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        $this->_grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->_grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @access public
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function delete_items($line_item_codes = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function empty_cart()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_grand_total = $this->_create_grand_total();
-        return $this->save_cart(true);
-    }
-
-
-    /**
-     * @remove ALL items from cart and delete total as well
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_cart()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-            if ($deleted) {
-                $deleted += $this->_grand_total->delete();
-                $this->_grand_total = null;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @save   cart to session
-     * @access public
-     * @param bool $apply_taxes
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_cart($apply_taxes = true)
-    {
-        if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-            // make sure we don't cache the transaction because it can get stale
-            if (
-                $this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->_grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->_grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        } else {
-            return false;
-        }
-    }
-
-
-    public function __wakeup()
-    {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
-            $this->_grand_total = $this->_grand_total->ID();
-        }
-        return array('_grand_total');
-    }
+	/**
+	 * instance of the EE_Cart object
+	 *
+	 * @access    private
+	 * @var EE_Cart $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @access    protected
+	 * @var EE_Session $_session
+	 */
+	protected $_session;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * @var EE_Line_Item
+	 */
+	private $_grand_total;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if (! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 */
+	private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * @return \EE_Session
+	 */
+	public function session()
+	{
+		if (! $this->_session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->_session;
+	}
+
+
+	/**
+	 * @param EE_Session $session
+	 */
+	public function set_session(EE_Session $session = null)
+	{
+		$this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->_grand_total = $line_item;
+	}
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param EE_Session     $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	private function _create_grand_total()
+	{
+		$this->_grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->_grand_total;
+	}
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @access public
+	 * @return \EE_Line_Item[]
+	 */
+	public function get_tickets()
+	{
+		if ($this->_grand_total === null) {
+			return array();
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
+	}
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @access public
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function all_ticket_quantity_count()
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->get('LIN_quantity');
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return \EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_taxes()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public function get_grand_total()
+	{
+		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
+	}
+
+
+	/**
+	 * @process items for adding to cart
+	 * @access  public
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
+		return $this->save_cart() ? true : false;
+	}
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_total_before_tax()
+	{
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_applied_taxes()
+	{
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_grand_total()
+	{
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function recalculate_all_cart_totals()
+	{
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->_grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @access public
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function delete_items($line_item_codes = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function empty_cart()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_grand_total = $this->_create_grand_total();
+		return $this->save_cart(true);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and delete total as well
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_cart()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+			if ($deleted) {
+				$deleted += $this->_grand_total->delete();
+				$this->_grand_total = null;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @save   cart to session
+	 * @access public
+	 * @param bool $apply_taxes
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_cart($apply_taxes = true)
+	{
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+			// make sure we don't cache the transaction because it can get stale
+			if (
+				$this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->_grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		} else {
+			return false;
+		}
+	}
+
+
+	public function __wakeup()
+	{
+		if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
+			$this->_grand_total = $this->_grand_total->ID();
+		}
+		return array('_grand_total');
+	}
 }

core/middleware/EE_Detect_Login.core.php

Indentation +23 added lines, -23 removed lines

@@ -13,27 +13,27 @@
 {
 
 
-    /**
-     * @deprecated
-     * @param    EE_Request  $request
-     * @param    EE_Response $response
-     * @return    EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\DetectLogin',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52'
-        );
-        return $response;
-    }
+	/**
+	 * @deprecated
+	 * @param    EE_Request  $request
+	 * @param    EE_Response $response
+	 * @return    EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\DetectLogin',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52'
+		);
+		return $response;
+	}
 }