eventespresso / event-espresso-core

core/db_models/relations/EE_Belongs_To_Any_Relation.php

Indentation +96 added lines, -96 removed lines

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

Spacing +6 added lines, -6 removed lines

@@ -35,20 +35,20 @@
         $this_table_alias     = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_fk_field->get_table_alias();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_fk_field->get_table_alias();
+        $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+            ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
         return $this->_left_join(
                 $other_table,
                 $other_table_alias,
                 $other_table_pk_field->get_table_column(),
                 $this_table_alias,
                 $this_table_fk_field->get_table_column(),
-                $field_with_model_name->get_qualified_column() . "='" . $this->get_other_model()->get_this_model_name(
-                ) . "'"
+                $field_with_model_name->get_qualified_column()."='".$this->get_other_model()->get_this_model_name(
+                )."'"
             )
                . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }

core/db_models/relations/EE_Belongs_To_Relation.php

Indentation +139 added lines, -139 removed lines

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

Spacing +6 added lines, -6 removed lines

@@ -46,19 +46,19 @@ 
         $this_table_alias     = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_fk_field->get_table_alias();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_fk_field->get_table_alias();
+        $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+            ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
         return $this->_left_join(
                 $other_table,
                 $other_table_alias,
                 $other_table_pk_field->get_table_column(),
                 $this_table_alias,
                 $this_table_fk_field->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+            ).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 
 
@@ -153,7 +153,7 @@ 
         }
         $ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
         // get all where their PK matches that value
-        $query_params[0][ $this->get_other_model()->get_primary_key_field()->get_name() ] = $ID_value_on_other_model;
+        $query_params[0][$this->get_other_model()->get_primary_key_field()->get_name()] = $ID_value_on_other_model;
         $query_params                                                                     =
             $this->_disable_default_where_conditions_on_query_param($query_params);
 //      echo '$query_params';

core/db_models/relations/EE_Has_Many_Revision_Relation.php

Indentation +316 added lines, -316 removed lines

@@ -10,323 +10,323 @@
  */
 class EE_Has_Many_Revision_Relation extends EE_Has_Many_Relation
 {
-    /**
-     * 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.
-     */
-    private string $_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).
-     */
-    private string $_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 bool   $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(
-        string $primary_cpt_field,
-        string $parent_pk_relation_field,
-        bool $block_deletes = true,
-        string $blocking_delete_error_message = ''
-    ) {
-        $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
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $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
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $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|null        $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
-     * @throws ReflectionException
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        ?array $query_params = [],
-        bool $values_already_prepared_by_model_object = false
-    ): array {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__(
-                    '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
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _do_autosave_get_all($model_object_or_id, $query_params): array
-    {
-        // 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 = [];
-        $return_objs        = [];
-
-        // 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 = method_exists($a_r, 'parent') ? $a_r->parent() : null;
-            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_params[0][ $query_param_where_this_model_pk ] = ['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|EE_Base_Class[] ($other_obj);
-     * @throws EE_Error
-     * @throws Exception
-     */
-    protected function _check_for_revision(
-        EE_Base_Class $this_obj,
-        EE_Base_Class $other_obj,
-        bool $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 instanceof EE_CPT_Base && $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.
+	 */
+	private string $_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).
+	 */
+	private string $_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 bool   $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(
+		string $primary_cpt_field,
+		string $parent_pk_relation_field,
+		bool $block_deletes = true,
+		string $blocking_delete_error_message = ''
+	) {
+		$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
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$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
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$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|null        $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
+	 * @throws ReflectionException
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		?array $query_params = [],
+		bool $values_already_prepared_by_model_object = false
+	): array {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__(
+					'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
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _do_autosave_get_all($model_object_or_id, $query_params): array
+	{
+		// 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 = [];
+		$return_objs        = [];
+
+		// 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 = method_exists($a_r, 'parent') ? $a_r->parent() : null;
+			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_params[0][ $query_param_where_this_model_pk ] = ['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|EE_Base_Class[] ($other_obj);
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	protected function _check_for_revision(
+		EE_Base_Class $this_obj,
+		EE_Base_Class $other_obj,
+		bool $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 instanceof EE_CPT_Base && $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(
-                    [
-                        [
-                            $this->_parent_pk_relation_field => $other_obj->ID(),
-                            $this->_primary_cpt_field        => $this_obj->ID(),
-                        ],
-                    ]
-                );
-
-                $other_obj->set($this->_parent_pk_relation_field, $other_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($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 [$other_obj];
-                    }
-                    if (! $this->_blocking_delete) {
-                        $other_obj->delete();
-                        $other_obj->set($this->_parent_pk_relation_field, null, true);
-                        return [$other_obj];
-                    }
-                } else {
-                    $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 [$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 (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 [$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(
+					[
+						[
+							$this->_parent_pk_relation_field => $other_obj->ID(),
+							$this->_primary_cpt_field        => $this_obj->ID(),
+						],
+					]
+				);
+
+				$other_obj->set($this->_parent_pk_relation_field, $other_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($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 [$other_obj];
+					}
+					if (! $this->_blocking_delete) {
+						$other_obj->delete();
+						$other_obj->set($this->_parent_pk_relation_field, null, true);
+						return [$other_obj];
+					}
+				} else {
+					$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 [$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 (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 [$new_obj];
+				}
+			}
+		}
+
+		return $other_obj;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -198,7 +198,7 @@ 
         // for those that DON'T have parents to merge with our returned objects);
         foreach ($autosave_relations as $a_r) {
             $pid = method_exists($a_r, 'parent') ? $a_r->parent() : null;
-            if (! empty($pid)) {
+            if ( ! empty($pid)) {
                 $parent_ids[] = $pid;
             } else {
                 $return_objs[] = $a_r;
@@ -214,11 +214,11 @@ 
         }
 
         // 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() . "."
+        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_params[0][ $query_param_where_this_model_pk ] = ['IN', $parent_ids];
+            $query_params[0][$query_param_where_this_model_pk] = ['IN', $parent_ids];
 
             $parents = $this->get_other_model()->get_all($query_params);
         }
@@ -258,7 +258,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(
                     [
@@ -276,11 +276,11 @@ 
                     $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 [$other_obj];
                     }
-                    if (! $this->_blocking_delete) {
+                    if ( ! $this->_blocking_delete) {
                         $other_obj->delete();
                         $other_obj->set($this->_parent_pk_relation_field, null, true);
                         return [$other_obj];
@@ -291,7 +291,7 @@ 
                         $pk_on_related_model,
                         null,
                         true
-                    );                  // ensure we create a new row for the autosave with parent id the same as the incoming ID.
+                    ); // 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 [$other_obj];
                 }
@@ -304,7 +304,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());

core/db_models/EEM_Transaction.model.php

Indentation +448 added lines, -448 removed lines

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

core/db_models/EEM_Message_Template_Group.model.php

Indentation +433 added lines, -433 removed lines

@@ -13,437 +13,437 @@
  */
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance = null;
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
-        $this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
-        $this->_tables          = [
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
-        ];
-        $this->_fields          = [
-            'Message_Template_Group' => [
-                'GRP_ID'           => new EE_Primary_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Message Template Group ID', 'event_espresso')
-                ),
-                'MTP_name'         => new EE_Plain_Text_Field(
-                    'MTP_name',
-                    esc_html__('The name of the template group', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'MTP_description'  => new EE_Simple_HTML_Field(
-                    'MTP_description',
-                    esc_html__(
-                        'A brief description about this template.',
-                        'event_espresso'
-                    ),
-                    false,
-                    ''
-                ),
-                'MTP_user_id'      => new EE_WP_User_Field(
-                    'MTP_user_id',
-                    esc_html__('Template Creator ID', 'event_espresso'),
-                    false
-                ),
-                'MTP_messenger'    => new EE_Plain_Text_Field(
-                    'MTP_messenger',
-                    esc_html__(
-                        'Messenger Used for Template',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MTP_message_type' => new EE_Plain_Text_Field(
-                    'MTP_message_type',
-                    esc_html__('Message Type', 'event_espresso'),
-                    false,
-                    'registration'
-                ),
-                'MTP_is_global'    => new EE_Boolean_Field(
-                    'MTP_is_global',
-                    esc_html__(
-                        'Flag indicating if Template Group is Global',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-                'MTP_is_override'  => new EE_Boolean_Field(
-                    'MTP_is_override',
-                    esc_html__(
-                        'Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'MTP_deleted'      => new EE_Trashed_Flag_Field(
-                    'MTP_deleted',
-                    esc_html__(
-                        'Flag indicating whether this has been trashed',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'MTP_is_active'    => new EE_Boolean_Field(
-                    'MTP_is_active',
-                    esc_html__(
-                        'Flag indicating whether template group is active',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message'          => new EE_Has_Many_Relation(),
-            'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User'          => new EE_Belongs_To_Relation(),
-        ];
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            [['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
-        );
-    }
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the request
-     *
-     * @param array $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = [])
-    {
-        /** @var RequestInterface $request */
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $messenger = $request->getRequestParam('ee_messenger_filter_by');
-        // account for messenger or message type filters
-        if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
-            $_where['MTP_messenger'] = $messenger;
-        }
-        $message_type = $request->getRequestParam('ee_message_type_filter_by');
-        if (
-            $message_type !== '' && $message_type !== 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $message_type;
-        }
-
-        return $_where;
-    }
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array|int all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        if (
-            $user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     *
-     * @param int   $EVT_ID       event id
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = [])
-    {
-        $where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
-        return $this->get_all(
-            [$where]
-        );
-    }
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return array|int EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param string              $messenger
-     * @param string              $message_type
-     * @param                     $evt_id
-     * @param string              $orderby pointless at this point but still included
-     * @param string              $order
-     * @param mixed (array|null) $limit   array($offset, $num)
-     * @param bool                $count   true = just return count, false = objects
-     * @param bool                $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID'     => $evt_id,
-            'MTP_is_global'    => true,
-            'MTP_is_active'    => $active,
-        ];
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param string $messenger     slug for messenger
-     * @param string $message_type  slug for message type
-     * @param string $orderby       what column to orderby
-     * @param string $order         ASC or DESC
-     * @param mixed (array|null) $limit array($offset, $num)
-     * @param bool   $count         true = just return count, false = objects
-     * @param bool   $active        ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global'    => true,
-        ];
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     *
-     * @param string $messenger    messenger
-     * @param string $message_type messagetype
-     * @param array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = [])
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                [
-                    [
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type,
-                    ],
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param array  $fields       the incoming fields to check.
-     *                             Note this array is in the formatted fields from the form fields setup.
-     *                             So we need to reformat this into an array of expected field refs by the validator.
-     *                             Note also that this is not only the fields for the Message Template Group
-     *                             but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return bool
-     * @throws DomainException
-     */
-    public function validate(array $fields, string $context, string $messenger, string $message_type): bool
-    {
-        /** @var MessageTemplateValidator $validator */
-        $validator = LoaderFactory::getShared(MessageTemplateValidator::class);
-        return $validator->validateTemplateFields($messenger, $message_type, $context, $fields);
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = [], $message_type_names = [])
-    {
-        $query_args = [];
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = ['IN', (array) $messenger_names];
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = ['IN', (array) $message_type_names];
-        }
-        return $this->update(['MTP_is_active' => false], $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance = null;
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
+		$this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
+		$this->_tables          = [
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
+		];
+		$this->_fields          = [
+			'Message_Template_Group' => [
+				'GRP_ID'           => new EE_Primary_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Message Template Group ID', 'event_espresso')
+				),
+				'MTP_name'         => new EE_Plain_Text_Field(
+					'MTP_name',
+					esc_html__('The name of the template group', 'event_espresso'),
+					false,
+					''
+				),
+				'MTP_description'  => new EE_Simple_HTML_Field(
+					'MTP_description',
+					esc_html__(
+						'A brief description about this template.',
+						'event_espresso'
+					),
+					false,
+					''
+				),
+				'MTP_user_id'      => new EE_WP_User_Field(
+					'MTP_user_id',
+					esc_html__('Template Creator ID', 'event_espresso'),
+					false
+				),
+				'MTP_messenger'    => new EE_Plain_Text_Field(
+					'MTP_messenger',
+					esc_html__(
+						'Messenger Used for Template',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MTP_message_type' => new EE_Plain_Text_Field(
+					'MTP_message_type',
+					esc_html__('Message Type', 'event_espresso'),
+					false,
+					'registration'
+				),
+				'MTP_is_global'    => new EE_Boolean_Field(
+					'MTP_is_global',
+					esc_html__(
+						'Flag indicating if Template Group is Global',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+				'MTP_is_override'  => new EE_Boolean_Field(
+					'MTP_is_override',
+					esc_html__(
+						'Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'MTP_deleted'      => new EE_Trashed_Flag_Field(
+					'MTP_deleted',
+					esc_html__(
+						'Flag indicating whether this has been trashed',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'MTP_is_active'    => new EE_Boolean_Field(
+					'MTP_is_active',
+					esc_html__(
+						'Flag indicating whether template group is active',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message'          => new EE_Has_Many_Relation(),
+			'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User'          => new EE_Belongs_To_Relation(),
+		];
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			[['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
+		);
+	}
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the request
+	 *
+	 * @param array $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = [])
+	{
+		/** @var RequestInterface $request */
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$messenger = $request->getRequestParam('ee_messenger_filter_by');
+		// account for messenger or message type filters
+		if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
+			$_where['MTP_messenger'] = $messenger;
+		}
+		$message_type = $request->getRequestParam('ee_message_type_filter_by');
+		if (
+			$message_type !== '' && $message_type !== 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $message_type;
+		}
+
+		return $_where;
+	}
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array|int all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		if (
+			$user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 *
+	 * @param int   $EVT_ID       event id
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = [])
+	{
+		$where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
+		return $this->get_all(
+			[$where]
+		);
+	}
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return array|int EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param string              $messenger
+	 * @param string              $message_type
+	 * @param                     $evt_id
+	 * @param string              $orderby pointless at this point but still included
+	 * @param string              $order
+	 * @param mixed (array|null) $limit   array($offset, $num)
+	 * @param bool                $count   true = just return count, false = objects
+	 * @param bool                $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID'     => $evt_id,
+			'MTP_is_global'    => true,
+			'MTP_is_active'    => $active,
+		];
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param string $messenger     slug for messenger
+	 * @param string $message_type  slug for message type
+	 * @param string $orderby       what column to orderby
+	 * @param string $order         ASC or DESC
+	 * @param mixed (array|null) $limit array($offset, $num)
+	 * @param bool   $count         true = just return count, false = objects
+	 * @param bool   $active        ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global'    => true,
+		];
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 *
+	 * @param string $messenger    messenger
+	 * @param string $message_type messagetype
+	 * @param array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = [])
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				[
+					[
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type,
+					],
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param array  $fields       the incoming fields to check.
+	 *                             Note this array is in the formatted fields from the form fields setup.
+	 *                             So we need to reformat this into an array of expected field refs by the validator.
+	 *                             Note also that this is not only the fields for the Message Template Group
+	 *                             but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function validate(array $fields, string $context, string $messenger, string $message_type): bool
+	{
+		/** @var MessageTemplateValidator $validator */
+		$validator = LoaderFactory::getShared(MessageTemplateValidator::class);
+		return $validator->validateTemplateFields($messenger, $message_type, $context, $fields);
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = [], $message_type_names = [])
+	{
+		$query_args = [];
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = ['IN', (array) $messenger_names];
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = ['IN', (array) $message_type_names];
+		}
+		return $this->update(['MTP_is_active' => false], $query_args);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -114,7 +114,7 @@ 
             'WP_User'          => new EE_Belongs_To_Relation(),
         ];
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -438,10 +438,10 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
+        if ( ! empty($messenger_names)) {
             $query_args[0]['MTP_messenger'] = ['IN', (array) $messenger_names];
         }
-        if (! empty($message_type_names)) {
+        if ( ! empty($message_type_names)) {
             $query_args[0]['MTP_message_type'] = ['IN', (array) $message_type_names];
         }
         return $this->update(['MTP_is_active' => false], $query_args);

core/db_models/EEM_Registration.model.php

Indentation +885 added lines, -885 removed lines

@@ -14,834 +14,834 @@ 
  */
 class EEM_Registration extends EEM_Soft_Delete_Base
 {
-    /**
-     * The value of REG_count for a primary registrant
-     */
-    const PRIMARY_REGISTRANT_COUNT = 1;
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
-     * Initial status for registrations when they are first created
-     * Payments are NOT allowed.
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
-     * information reg step NO space reserved. Registration is NOT active
-     */
-    const status_id_incomplete = 'RIC';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
-     * Payments are NOT allowed.
-     * Event Admin must manually toggle STS_ID for it to change
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_not_approved = 'RNA';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_pending_payment = 'RPP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_wait_list = 'RWL';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
-     * the TXN may or may not be completed ( paid in full )
-     * Payments are allowed.
-     * A space IS reserved.
-     * Registration is active
-     */
-    const status_id_approved = 'RAP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
-     * Payments are NOT allowed.
-     * NO space reserved.
-     * Registration is NOT active
-     */
-    const status_id_cancelled = 'RCN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
-     * Payments are NOT allowed.
-     * No space reserved.
-     * Registration is NOT active
-     */
-    const status_id_declined = 'RDC';
-
-
-    protected static ?EEM_Registration $_instance       = null;
-
-    protected ?TableAnalysis           $_table_analysis = null;
-
-    /**
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
-     * are status codes (eg, approved, cancelled, etc)
-     *
-     * @var array|null
-     */
-    private static array $_reg_status = [];
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                              any incoming timezone data that gets saved). Note this just sends the timezone info
-     *                              to the date time model field objects.  Default is NULL (and will be assumed using
-     *                              the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->_table_analysis         = EE_Registry::instance()->create('TableAnalysis', [], true);
-        $this->singular_item           = esc_html__('Registration', 'event_espresso');
-        $this->plural_item             = esc_html__('Registrations', 'event_espresso');
-        $this->_tables                 = [
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
-        ];
-        $this->_fields                 = [
-            'Registration' => [
-                'REG_ID'           => new EE_Primary_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso')
-                ),
-                'EVT_ID'           => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'ATT_ID'           => new EE_Foreign_Key_Int_Field(
-                    'ATT_ID',
-                    esc_html__('Attendee ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Attendee'
-                ),
-                'TXN_ID'           => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'TKT_ID'           => new EE_Foreign_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket'
-                ),
-                'STS_ID'           => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Registration::status_id_incomplete,
-                    'Status'
-                ),
-                'REG_date'         => new EE_Datetime_Field(
-                    'REG_date',
-                    esc_html__('Time registration occurred', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'REG_final_price'  => new EE_Money_Field(
-                    'REG_final_price',
-                    esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_paid'         => new EE_Money_Field(
-                    'REG_paid',
-                    esc_html__('Amount paid to date towards registration', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_session'      => new EE_Plain_Text_Field(
-                    'REG_session',
-                    esc_html__('Session ID of registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_code'         => new EE_Plain_Text_Field(
-                    'REG_code',
-                    esc_html__('Unique Code for this registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_url_link'     => new EE_Plain_Text_Field(
-                    'REG_url_link',
-                    esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_count'        => new EE_Integer_Field(
-                    'REG_count',
-                    esc_html__('Count of this registration in the group registration', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'REG_group_size'   => new EE_Integer_Field(
-                    'REG_group_size',
-                    esc_html__('Number of registrations on this group', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'REG_att_is_going' => new EE_Boolean_Field(
-                    'REG_att_is_going',
-                    esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'REG_deleted'      => new EE_Trashed_Flag_Field(
-                    'REG_deleted',
-                    esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Event'                => new EE_Belongs_To_Relation(),
-            'Attendee'             => new EE_Belongs_To_Relation(),
-            'Transaction'          => new EE_Belongs_To_Relation(),
-            'Ticket'               => new EE_Belongs_To_Relation(),
-            'Status'               => new EE_Belongs_To_Relation(),
-            'Answer'               => new EE_Has_Many_Relation(),
-            'Checkin'              => new EE_Has_Many_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
-            'Message'              => new EE_Has_Many_Any_Relation(false),
-            // allow deletes even if there are messages in the queue related
-        ];
-        $this->_model_chain_to_wp_user = 'Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * a list of ALL valid registration statuses currently in use within the system
-     * generated by combining the filterable active and inactive reg status arrays
-     *
-     * @return array
-     */
-    public static function reg_statuses(): array
-    {
-        return array_unique(
-            array_merge(
-                EEM_Registration::active_reg_statuses(),
-                EEM_Registration::inactive_reg_statuses()
-            )
-        );
-    }
-
-
-    /**
-     * reg_statuses_that_allow_payment
-     * a filterable list of registration statuses that allow a registrant to make a payment
-     *
-     * @access public
-     * @return array
-     */
-    public static function reg_statuses_that_allow_payment(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            [
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-            ]
-        );
-    }
-
-
-    /**
-     * active_reg_statuses
-     * a filterable list of registration statuses that are considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function active_reg_statuses(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EEM_Registration__active_reg_statuses',
-            [
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-                EEM_Registration::status_id_not_approved,
-            ]
-        );
-    }
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are not considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function inactive_reg_statuses(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EEM_Registration__inactive_reg_statuses',
-            [
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            ]
-        );
-    }
-
-
-    /**
-     *    closed_reg_statuses
-     *    a filterable list of registration statuses that are considered "closed"
-     * meaning they should not be considered in any calculations involving monies owing
-     *
-     * @access public
-     * @return array
-     */
-    public static function closed_reg_statuses(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EEM_Registration__closed_reg_statuses',
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_wait_list,
-            ]
-        );
-    }
-
-
-    /**
-     * get list of registration statuses
-     *
-     * @param array $exclude    The status ids to exclude from the returned results
-     * @param bool  $translated If true will return the values as singular localized strings
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reg_status_array(array $exclude = [], bool $translated = false): array
-    {
-        if (empty(self::$_reg_status)) {
-            EEM_Registration::instance()->_get_registration_status_array($exclude);
-        }
-        return $translated
-            ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
-            : self::$_reg_status;
-    }
-
-
-    /**
-     * get list of registration statuses
-     *
-     * @param array $exclude
-     * @param bool  $recurse
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registration_status_array(array $exclude = [], bool $recurse = true)
-    {
-        // in the very rare circumstance that we are deleting a model's table's data
-        // and the table hasn't actually been created, this could have an error
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
-            $results           = $wpdb->get_results(
-                "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
-            );
-            self::$_reg_status = [];
-            foreach ($results as $status) {
-                if (! in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
-                }
-            }
-        }
-        // in case reg status codes have been deleted from db
-        if ($recurse && empty(self::$_reg_status)) {
-            EEH_Activation::insert_default_status_codes();
-            EEM_Registration::instance()->_get_registration_status_array($exclude, false);
-        }
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis(): TableAnalysis
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
-     * and grouped by month and year.
-     *
-     * @param array $where_params
-     * @return bool|stdClass[]
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public function get_reg_months_and_years(array $where_params)
-    {
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = ['reg_year', 'reg_month'];
-        $query_params['order_by'] = ['REG_date' => 'DESC'];
-        $columns_to_select        = [
-            'reg_year'  => ['YEAR(REG_date)', '%s'],
-            'reg_month' => ['MONTHNAME(REG_date)', '%s'],
-        ];
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * retrieve ALL registrations for a particular Attendee from db
-     *
-     * @param int $ATT_ID
-     * @return EE_Registration[]|bool|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_registrations_for_attendee(int $ATT_ID = 0): ?array
-    {
-        if (! $ATT_ID) {
-            return null;
-        }
-        return $this->get_all([['ATT_ID' => $ATT_ID]]);
-    }
-
-
-    /**
-     * Gets a registration given their REG_url_link. Yes, this should usually
-     * be passed via a GET parameter.
-     *
-     * @param string $REG_url_link
-     * @return EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_registration_for_reg_url_link(string $REG_url_link): ?EE_Registration
-    {
-        if (! $REG_url_link) {
-            return null;
-        }
-        return $this->get_one([['REG_url_link' => $REG_url_link]]);
-    }
-
-
-    /**
-     *        retrieve registration for a specific transaction attendee from db
-     *
-     * @access        public
-     * @param int $TXN_ID
-     * @param int $ATT_ID
-     * @param int $att_nmbr    in case the ATT_ID is the same for multiple registrations (same details used) then the
-     *                         attendee number is required
-     * @return EE_Registration|null array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_registration_for_transaction_attendee(int $TXN_ID = 0, int $ATT_ID = 0, int $att_nmbr = 0):
-    ?EE_Registration {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID' => $TXN_ID,
-                    'ATT_ID' => $ATT_ID,
-                ],
-                'limit' => [min($att_nmbr - 1, 0), 1],
-            ]
-        );
-    }
-
-
-    /**
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
-     *        (doesn't utilize models because it's a fairly specialized query)
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return EE_Registration[]|bool|null with properties regDate and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_day_report(string $period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where    = [
-            'REG_date' => ['>=', $sql_date],
-            'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
-        ];
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
-        return $this->_get_all_wpdb_results(
-            [
-                $where,
-                'group_by' => 'regDate',
-                'order_by' => ['REG_date' => 'ASC'],
-            ],
-            OBJECT,
-            [
-                'regDate' => ['DATE(' . $query_interval . ')', '%s'],
-                'total'   => ['count(REG_ID)', '%d'],
-            ]
-        );
-    }
-
-
-    /**
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_registrations_per_day_and_per_status_report(string $period = '-1 month'): array
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table        = $wpdb->posts;
-        $sql_date           = date('Y-m-d H:i:s', strtotime($period));
-        // prepare the query interval for displaying offset
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
-        $inner_where      = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where      .= " REG_date >= '$sql_date'";
-        $inner_date_query .= $inner_where;
-        // start main query
-        $select       = "SELECT DATE($query_interval) as Registration_REG_date, ";
-        $join         = '';
-        $join_parts   = [];
-        $select_parts = [];
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
-            $join_parts[]   =
-                "$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
-        // setup the joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
-        // and execute it
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] each with properties event_name, reg_limit, and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_event_report(string $period = '-1 month'): array
-    {
-        $date_sql = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where    = [
-            'REG_date' => ['>=', $date_sql],
-            'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
-        ];
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_registrations',
-                'reg_per_event_report'
-            )
-        ) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        return $this->_get_all_wpdb_results(
-            [
-                $where,
-                'group_by' => 'Event.EVT_name',
-                'order_by' => 'Event.EVT_name',
-                'limit'    => [0, 24],
-            ],
-            OBJECT,
-            [
-                'event_name' => ['Event_CPT.post_title', '%s'],
-                'total'      => ['COUNT(REG_ID)', '%s'],
-            ]
-        );
-    }
-
-
-    /**
-     * Get the number of registrations per event grouped by registration status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
-     *                    (i.e. RAP)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_registrations_per_event_and_per_status_report(string $period = '-1 month'): array
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table        = $wpdb->posts;
-        $sql_date           = date('Y-m-d H:i:s', strtotime($period));
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
-        $inner_where      = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where      .= " REG_date >= '$sql_date'";
-        $inner_date_query .= $inner_where;
-        // build main query
-        $select       = 'SELECT Event.post_title as Registration_Event, ';
-        $join         = '';
-        $join_parts   = [];
-        $select_parts = [];
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
-            $join_parts[]   =
-                "$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
-        // setup remaining joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
-        // and execute
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
-     *
-     * @param int $TXN_ID
-     * @return EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_primary_registration_for_transaction_ID(int $TXN_ID = 0): ?EE_Registration
-    {
-        if (! $TXN_ID) {
-            return null;
-        }
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'    => $TXN_ID,
-                    'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     *        get_event_registration_count
-     *
-     * @access public
-     * @param int     $EVT_ID
-     * @param boolean $for_incomplete_payments
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_event_registration_count(int $EVT_ID, bool $for_incomplete_payments = false): int
-    {
-        // we only count approved registrations towards registration limits
-        $query_params = [['EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved]];
-        if ($for_incomplete_payments) {
-            $query_params[0]['Transaction.STS_ID'] = ['!=', EEM_Transaction::complete_status_code];
-        }
-        return $this->count($query_params);
-    }
-
-
-    /**
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
-     * and so it uses wpdb directly. Also, we can't put a limit on this because MySQL doesn't allow a limit on a delete
-     * when joining tables like this.
-     *
-     * @return int|bool number deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global WPDB $wpdb
-     */
-    public function delete_registrations_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            'DELETE r FROM '
-            . $this->table()
-            . ' r LEFT JOIN '
-            . EEM_Transaction::instance()->table()
-            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
-        );
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) a datetime
-     *
-     * @param int  $DTT_ID     datetime ID
-     * @param bool $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function count_registrations_checked_into_datetime(int $DTT_ID, bool $checked_in = true): int
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
-            . 'WHERE DTT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $DTT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) an event.
-     *
-     * @param int  $EVT_ID     event ID
-     * @param bool $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function count_registrations_checked_into_event(int $EVT_ID, bool $checked_in = true): int
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
-            . 'ON c.DTT_ID=d.DTT_ID '
-            . 'WHERE d.EVT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $EVT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     * The purpose of this method is to retrieve an array of
-     * EE_Registration objects that represent the latest registration
-     * for each ATT_ID given in the function argument.
-     *
-     * @param array $attendee_ids
-     * @return EE_Registration[]|bool|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_latest_registration_for_each_of_given_contacts(array $attendee_ids = [])
-    {
-        // first do a native wp_query to get the latest REG_ID's matching these attendees.
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $attendee_table     = $wpdb->posts;
-        $attendee_ids       = is_array($attendee_ids)
-            ? array_map('absint', $attendee_ids)
-            : [(int) $attendee_ids];
-        $ATT_IDs            = implode(',', $attendee_ids);
-        // first we do a query to get the registration ids
-        // (because a group by before order by causes the order by to be ignored.)
-        $registration_id_query = "
+	/**
+	 * The value of REG_count for a primary registrant
+	 */
+	const PRIMARY_REGISTRANT_COUNT = 1;
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
+	 * Initial status for registrations when they are first created
+	 * Payments are NOT allowed.
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
+	 * information reg step NO space reserved. Registration is NOT active
+	 */
+	const status_id_incomplete = 'RIC';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
+	 * Payments are NOT allowed.
+	 * Event Admin must manually toggle STS_ID for it to change
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_not_approved = 'RNA';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_pending_payment = 'RPP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_wait_list = 'RWL';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
+	 * the TXN may or may not be completed ( paid in full )
+	 * Payments are allowed.
+	 * A space IS reserved.
+	 * Registration is active
+	 */
+	const status_id_approved = 'RAP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
+	 * Payments are NOT allowed.
+	 * NO space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_cancelled = 'RCN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
+	 * Payments are NOT allowed.
+	 * No space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_declined = 'RDC';
+
+
+	protected static ?EEM_Registration $_instance       = null;
+
+	protected ?TableAnalysis           $_table_analysis = null;
+
+	/**
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
+	 * are status codes (eg, approved, cancelled, etc)
+	 *
+	 * @var array|null
+	 */
+	private static array $_reg_status = [];
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                              any incoming timezone data that gets saved). Note this just sends the timezone info
+	 *                              to the date time model field objects.  Default is NULL (and will be assumed using
+	 *                              the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->_table_analysis         = EE_Registry::instance()->create('TableAnalysis', [], true);
+		$this->singular_item           = esc_html__('Registration', 'event_espresso');
+		$this->plural_item             = esc_html__('Registrations', 'event_espresso');
+		$this->_tables                 = [
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
+		];
+		$this->_fields                 = [
+			'Registration' => [
+				'REG_ID'           => new EE_Primary_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso')
+				),
+				'EVT_ID'           => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'ATT_ID'           => new EE_Foreign_Key_Int_Field(
+					'ATT_ID',
+					esc_html__('Attendee ID', 'event_espresso'),
+					false,
+					0,
+					'Attendee'
+				),
+				'TXN_ID'           => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'TKT_ID'           => new EE_Foreign_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket'
+				),
+				'STS_ID'           => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Registration::status_id_incomplete,
+					'Status'
+				),
+				'REG_date'         => new EE_Datetime_Field(
+					'REG_date',
+					esc_html__('Time registration occurred', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'REG_final_price'  => new EE_Money_Field(
+					'REG_final_price',
+					esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_paid'         => new EE_Money_Field(
+					'REG_paid',
+					esc_html__('Amount paid to date towards registration', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_session'      => new EE_Plain_Text_Field(
+					'REG_session',
+					esc_html__('Session ID of registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_code'         => new EE_Plain_Text_Field(
+					'REG_code',
+					esc_html__('Unique Code for this registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_url_link'     => new EE_Plain_Text_Field(
+					'REG_url_link',
+					esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_count'        => new EE_Integer_Field(
+					'REG_count',
+					esc_html__('Count of this registration in the group registration', 'event_espresso'),
+					true,
+					1
+				),
+				'REG_group_size'   => new EE_Integer_Field(
+					'REG_group_size',
+					esc_html__('Number of registrations on this group', 'event_espresso'),
+					false,
+					1
+				),
+				'REG_att_is_going' => new EE_Boolean_Field(
+					'REG_att_is_going',
+					esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
+					false,
+					false
+				),
+				'REG_deleted'      => new EE_Trashed_Flag_Field(
+					'REG_deleted',
+					esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Event'                => new EE_Belongs_To_Relation(),
+			'Attendee'             => new EE_Belongs_To_Relation(),
+			'Transaction'          => new EE_Belongs_To_Relation(),
+			'Ticket'               => new EE_Belongs_To_Relation(),
+			'Status'               => new EE_Belongs_To_Relation(),
+			'Answer'               => new EE_Has_Many_Relation(),
+			'Checkin'              => new EE_Has_Many_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
+			'Message'              => new EE_Has_Many_Any_Relation(false),
+			// allow deletes even if there are messages in the queue related
+		];
+		$this->_model_chain_to_wp_user = 'Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * a list of ALL valid registration statuses currently in use within the system
+	 * generated by combining the filterable active and inactive reg status arrays
+	 *
+	 * @return array
+	 */
+	public static function reg_statuses(): array
+	{
+		return array_unique(
+			array_merge(
+				EEM_Registration::active_reg_statuses(),
+				EEM_Registration::inactive_reg_statuses()
+			)
+		);
+	}
+
+
+	/**
+	 * reg_statuses_that_allow_payment
+	 * a filterable list of registration statuses that allow a registrant to make a payment
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function reg_statuses_that_allow_payment(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			[
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+			]
+		);
+	}
+
+
+	/**
+	 * active_reg_statuses
+	 * a filterable list of registration statuses that are considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function active_reg_statuses(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EEM_Registration__active_reg_statuses',
+			[
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+				EEM_Registration::status_id_not_approved,
+			]
+		);
+	}
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are not considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function inactive_reg_statuses(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EEM_Registration__inactive_reg_statuses',
+			[
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			]
+		);
+	}
+
+
+	/**
+	 *    closed_reg_statuses
+	 *    a filterable list of registration statuses that are considered "closed"
+	 * meaning they should not be considered in any calculations involving monies owing
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function closed_reg_statuses(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EEM_Registration__closed_reg_statuses',
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_wait_list,
+			]
+		);
+	}
+
+
+	/**
+	 * get list of registration statuses
+	 *
+	 * @param array $exclude    The status ids to exclude from the returned results
+	 * @param bool  $translated If true will return the values as singular localized strings
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reg_status_array(array $exclude = [], bool $translated = false): array
+	{
+		if (empty(self::$_reg_status)) {
+			EEM_Registration::instance()->_get_registration_status_array($exclude);
+		}
+		return $translated
+			? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
+			: self::$_reg_status;
+	}
+
+
+	/**
+	 * get list of registration statuses
+	 *
+	 * @param array $exclude
+	 * @param bool  $recurse
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registration_status_array(array $exclude = [], bool $recurse = true)
+	{
+		// in the very rare circumstance that we are deleting a model's table's data
+		// and the table hasn't actually been created, this could have an error
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+			$results           = $wpdb->get_results(
+				"SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
+			);
+			self::$_reg_status = [];
+			foreach ($results as $status) {
+				if (! in_array($status->STS_ID, $exclude, true)) {
+					self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+				}
+			}
+		}
+		// in case reg status codes have been deleted from db
+		if ($recurse && empty(self::$_reg_status)) {
+			EEH_Activation::insert_default_status_codes();
+			EEM_Registration::instance()->_get_registration_status_array($exclude, false);
+		}
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis(): TableAnalysis
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
+	 * and grouped by month and year.
+	 *
+	 * @param array $where_params
+	 * @return bool|stdClass[]
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public function get_reg_months_and_years(array $where_params)
+	{
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = ['reg_year', 'reg_month'];
+		$query_params['order_by'] = ['REG_date' => 'DESC'];
+		$columns_to_select        = [
+			'reg_year'  => ['YEAR(REG_date)', '%s'],
+			'reg_month' => ['MONTHNAME(REG_date)', '%s'],
+		];
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * retrieve ALL registrations for a particular Attendee from db
+	 *
+	 * @param int $ATT_ID
+	 * @return EE_Registration[]|bool|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_registrations_for_attendee(int $ATT_ID = 0): ?array
+	{
+		if (! $ATT_ID) {
+			return null;
+		}
+		return $this->get_all([['ATT_ID' => $ATT_ID]]);
+	}
+
+
+	/**
+	 * Gets a registration given their REG_url_link. Yes, this should usually
+	 * be passed via a GET parameter.
+	 *
+	 * @param string $REG_url_link
+	 * @return EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_reg_url_link(string $REG_url_link): ?EE_Registration
+	{
+		if (! $REG_url_link) {
+			return null;
+		}
+		return $this->get_one([['REG_url_link' => $REG_url_link]]);
+	}
+
+
+	/**
+	 *        retrieve registration for a specific transaction attendee from db
+	 *
+	 * @access        public
+	 * @param int $TXN_ID
+	 * @param int $ATT_ID
+	 * @param int $att_nmbr    in case the ATT_ID is the same for multiple registrations (same details used) then the
+	 *                         attendee number is required
+	 * @return EE_Registration|null array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_transaction_attendee(int $TXN_ID = 0, int $ATT_ID = 0, int $att_nmbr = 0):
+	?EE_Registration {
+		return $this->get_one(
+			[
+				[
+					'TXN_ID' => $TXN_ID,
+					'ATT_ID' => $ATT_ID,
+				],
+				'limit' => [min($att_nmbr - 1, 0), 1],
+			]
+		);
+	}
+
+
+	/**
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
+	 *        (doesn't utilize models because it's a fairly specialized query)
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return EE_Registration[]|bool|null with properties regDate and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_day_report(string $period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where    = [
+			'REG_date' => ['>=', $sql_date],
+			'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
+		];
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
+		return $this->_get_all_wpdb_results(
+			[
+				$where,
+				'group_by' => 'regDate',
+				'order_by' => ['REG_date' => 'ASC'],
+			],
+			OBJECT,
+			[
+				'regDate' => ['DATE(' . $query_interval . ')', '%s'],
+				'total'   => ['count(REG_ID)', '%d'],
+			]
+		);
+	}
+
+
+	/**
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_registrations_per_day_and_per_status_report(string $period = '-1 month'): array
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table        = $wpdb->posts;
+		$sql_date           = date('Y-m-d H:i:s', strtotime($period));
+		// prepare the query interval for displaying offset
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
+		$inner_where      = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
+			$inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where      .= " REG_date >= '$sql_date'";
+		$inner_date_query .= $inner_where;
+		// start main query
+		$select       = "SELECT DATE($query_interval) as Registration_REG_date, ";
+		$join         = '';
+		$join_parts   = [];
+		$select_parts = [];
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
+			$join_parts[]   =
+				"$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
+		// setup the joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now let's put it all together
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
+		// and execute it
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_event_report(string $period = '-1 month'): array
+	{
+		$date_sql = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where    = [
+			'REG_date' => ['>=', $date_sql],
+			'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
+		];
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_registrations',
+				'reg_per_event_report'
+			)
+		) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		return $this->_get_all_wpdb_results(
+			[
+				$where,
+				'group_by' => 'Event.EVT_name',
+				'order_by' => 'Event.EVT_name',
+				'limit'    => [0, 24],
+			],
+			OBJECT,
+			[
+				'event_name' => ['Event_CPT.post_title', '%s'],
+				'total'      => ['COUNT(REG_ID)', '%s'],
+			]
+		);
+	}
+
+
+	/**
+	 * Get the number of registrations per event grouped by registration status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
+	 *                    (i.e. RAP)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_registrations_per_event_and_per_status_report(string $period = '-1 month'): array
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table        = $wpdb->posts;
+		$sql_date           = date('Y-m-d H:i:s', strtotime($period));
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
+		$inner_where      = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
+			$inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where      .= " REG_date >= '$sql_date'";
+		$inner_date_query .= $inner_where;
+		// build main query
+		$select       = 'SELECT Event.post_title as Registration_Event, ';
+		$join         = '';
+		$join_parts   = [];
+		$select_parts = [];
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
+			$join_parts[]   =
+				"$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
+		// setup remaining joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now put it all together
+		$query = $select . $join . ' GROUP BY Registration_Event';
+		// and execute
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration_for_transaction_ID(int $TXN_ID = 0): ?EE_Registration
+	{
+		if (! $TXN_ID) {
+			return null;
+		}
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'    => $TXN_ID,
+					'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 *        get_event_registration_count
+	 *
+	 * @access public
+	 * @param int     $EVT_ID
+	 * @param boolean $for_incomplete_payments
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_event_registration_count(int $EVT_ID, bool $for_incomplete_payments = false): int
+	{
+		// we only count approved registrations towards registration limits
+		$query_params = [['EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved]];
+		if ($for_incomplete_payments) {
+			$query_params[0]['Transaction.STS_ID'] = ['!=', EEM_Transaction::complete_status_code];
+		}
+		return $this->count($query_params);
+	}
+
+
+	/**
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
+	 * and so it uses wpdb directly. Also, we can't put a limit on this because MySQL doesn't allow a limit on a delete
+	 * when joining tables like this.
+	 *
+	 * @return int|bool number deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global WPDB $wpdb
+	 */
+	public function delete_registrations_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			'DELETE r FROM '
+			. $this->table()
+			. ' r LEFT JOIN '
+			. EEM_Transaction::instance()->table()
+			. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
+		);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) a datetime
+	 *
+	 * @param int  $DTT_ID     datetime ID
+	 * @param bool $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function count_registrations_checked_into_datetime(int $DTT_ID, bool $checked_in = true): int
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' '
+			. 'WHERE DTT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$DTT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) an event.
+	 *
+	 * @param int  $EVT_ID     event ID
+	 * @param bool $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function count_registrations_checked_into_event(int $EVT_ID, bool $checked_in = true): int
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
+			. 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+			. 'ON c.DTT_ID=d.DTT_ID '
+			. 'WHERE d.EVT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$EVT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 * The purpose of this method is to retrieve an array of
+	 * EE_Registration objects that represent the latest registration
+	 * for each ATT_ID given in the function argument.
+	 *
+	 * @param array $attendee_ids
+	 * @return EE_Registration[]|bool|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_latest_registration_for_each_of_given_contacts(array $attendee_ids = [])
+	{
+		// first do a native wp_query to get the latest REG_ID's matching these attendees.
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$attendee_table     = $wpdb->posts;
+		$attendee_ids       = is_array($attendee_ids)
+			? array_map('absint', $attendee_ids)
+			: [(int) $attendee_ids];
+		$ATT_IDs            = implode(',', $attendee_ids);
+		// first we do a query to get the registration ids
+		// (because a group by before order by causes the order by to be ignored.)
+		$registration_id_query = "
 			SELECT registrations.registration_ids as registration_id
 			FROM (
 				SELECT
@@ -855,61 +855,61 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids      = $wpdb->get_results($registration_id_query, ARRAY_A);
-        if (empty($registration_ids)) {
-            return [];
-        }
-        $ids_for_model_query = [];
-        // let's flatten the ids so they can be used in the model query.
-        foreach ($registration_ids as $registration_id) {
-            if (isset($registration_id['registration_id'])) {
-                $ids_for_model_query[] = $registration_id['registration_id'];
-            }
-        }
-        // construct query
-        $_where = [
-            'REG_ID' => ['IN', $ids_for_model_query],
-        ];
-        return $this->get_all([$_where]);
-    }
-
-
-    /**
-     * returns a count of registrations for the supplied event having the status as specified
-     *
-     * @param int          $EVT_ID
-     * @param array|string $statuses
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidStatusException
-     * @throws EE_Error
-     */
-    public function event_reg_count_for_statuses(int $EVT_ID, $statuses = []): int
-    {
-        $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
-            throw new InvalidArgumentException(
-                esc_html__('An invalid Event ID was supplied.', 'event_espresso')
-            );
-        }
-        $statuses = is_array($statuses) ? $statuses : [$statuses];
-        $statuses = ! empty($statuses) ? $statuses : [EEM_Registration::status_id_approved];
-
-        $valid_reg_statuses = EEM_Registration::reg_statuses();
-        foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
-                throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
-            }
-        }
-        return $this->count(
-            [
-                [
-                    'EVT_ID' => $EVT_ID,
-                    'STS_ID' => ['IN', $statuses],
-                ],
-            ],
-            'REG_ID',
-            true
-        );
-    }
+		$registration_ids      = $wpdb->get_results($registration_id_query, ARRAY_A);
+		if (empty($registration_ids)) {
+			return [];
+		}
+		$ids_for_model_query = [];
+		// let's flatten the ids so they can be used in the model query.
+		foreach ($registration_ids as $registration_id) {
+			if (isset($registration_id['registration_id'])) {
+				$ids_for_model_query[] = $registration_id['registration_id'];
+			}
+		}
+		// construct query
+		$_where = [
+			'REG_ID' => ['IN', $ids_for_model_query],
+		];
+		return $this->get_all([$_where]);
+	}
+
+
+	/**
+	 * returns a count of registrations for the supplied event having the status as specified
+	 *
+	 * @param int          $EVT_ID
+	 * @param array|string $statuses
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidStatusException
+	 * @throws EE_Error
+	 */
+	public function event_reg_count_for_statuses(int $EVT_ID, $statuses = []): int
+	{
+		$EVT_ID = absint($EVT_ID);
+		if (! $EVT_ID) {
+			throw new InvalidArgumentException(
+				esc_html__('An invalid Event ID was supplied.', 'event_espresso')
+			);
+		}
+		$statuses = is_array($statuses) ? $statuses : [$statuses];
+		$statuses = ! empty($statuses) ? $statuses : [EEM_Registration::status_id_approved];
+
+		$valid_reg_statuses = EEM_Registration::reg_statuses();
+		foreach ($statuses as $status) {
+			if (! in_array($status, $valid_reg_statuses, true)) {
+				throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
+			}
+		}
+		return $this->count(
+			[
+				[
+					'EVT_ID' => $EVT_ID,
+					'STS_ID' => ['IN', $statuses],
+				],
+			],
+			'REG_ID',
+			true
+		);
+	}
 }

Spacing +28 added lines, -28 removed lines

@@ -216,7 +216,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Event'                => new EE_Belongs_To_Relation(),
             'Attendee'             => new EE_Belongs_To_Relation(),
             'Transaction'          => new EE_Belongs_To_Relation(),
@@ -367,14 +367,14 @@ 
         // and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results           = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
             self::$_reg_status = [];
             foreach ($results as $status) {
-                if (! in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+                if ( ! in_array($status->STS_ID, $exclude, true)) {
+                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
                 }
             }
         }
@@ -438,7 +438,7 @@ 
      */
     public function get_all_registrations_for_attendee(int $ATT_ID = 0): ?array
     {
-        if (! $ATT_ID) {
+        if ( ! $ATT_ID) {
             return null;
         }
         return $this->get_all([['ATT_ID' => $ATT_ID]]);
@@ -455,7 +455,7 @@ 
      */
     public function get_registration_for_reg_url_link(string $REG_url_link): ?EE_Registration
     {
-        if (! $REG_url_link) {
+        if ( ! $REG_url_link) {
             return null;
         }
         return $this->get_one([['REG_url_link' => $REG_url_link]]);
@@ -504,11 +504,11 @@ 
             'Y-m-d H:i:s',
             'UTC'
         );
-        $where    = [
+        $where = [
             'REG_date' => ['>=', $sql_date],
             'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
         ];
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
             $where['Event.EVT_wp_user'] = get_current_user_id();
         }
         $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
@@ -520,7 +520,7 @@ 
             ],
             OBJECT,
             [
-                'regDate' => ['DATE(' . $query_interval . ')', '%s'],
+                'regDate' => ['DATE('.$query_interval.')', '%s'],
                 'total'   => ['count(REG_ID)', '%d'],
             ]
         );
@@ -540,7 +540,7 @@ 
     public function get_registrations_per_day_and_per_status_report(string $period = '-1 month'): array
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table        = $wpdb->posts;
         $sql_date           = date('Y-m-d H:i:s', strtotime($period));
         // prepare the query interval for displaying offset
@@ -549,9 +549,9 @@ 
         $inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
         $inner_where      = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where      .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where      .= " REG_date >= '$sql_date'";
         $inner_date_query .= $inner_where;
@@ -575,7 +575,7 @@ 
         // setup the joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
+        $query = $select.$join.' GROUP BY Registration_REG_date';
         // and execute it
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -597,7 +597,7 @@ 
             'Y-m-d H:i:s',
             'UTC'
         );
-        $where    = [
+        $where = [
             'REG_date' => ['>=', $date_sql],
             'STS_ID'   => ['!=', EEM_Registration::status_id_incomplete],
         ];
@@ -638,16 +638,16 @@ 
     public function get_registrations_per_event_and_per_status_report(string $period = '-1 month'): array
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table        = $wpdb->posts;
         $sql_date           = date('Y-m-d H:i:s', strtotime($period));
         // inner date query
         $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
         $inner_where      = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where      .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where      .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where      .= " REG_date >= '$sql_date'";
         $inner_date_query .= $inner_where;
@@ -671,7 +671,7 @@ 
         // setup remaining joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
+        $query = $select.$join.' GROUP BY Registration_Event';
         // and execute
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -686,7 +686,7 @@ 
      */
     public function get_primary_registration_for_transaction_ID(int $TXN_ID = 0): ?EE_Registration
     {
-        if (! $TXN_ID) {
+        if ( ! $TXN_ID) {
             return null;
         }
         return $this->get_one(
@@ -761,11 +761,11 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
+            . 'FROM '.EEM_Checkin::instance()->table().' '
             . 'WHERE DTT_ID=%d '
             . 'GROUP BY REG_ID'
             . ') AS most_recent_checkin_per_reg '
@@ -798,12 +798,12 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+            . 'FROM '.EEM_Checkin::instance()->table().' AS c '
+            . 'INNER JOIN '.EEM_Datetime::instance()->table().' AS d '
             . 'ON c.DTT_ID=d.DTT_ID '
             . 'WHERE d.EVT_ID=%d '
             . 'GROUP BY REG_ID'
@@ -833,7 +833,7 @@ 
     {
         // first do a native wp_query to get the latest REG_ID's matching these attendees.
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $attendee_table     = $wpdb->posts;
         $attendee_ids       = is_array($attendee_ids)
             ? array_map('absint', $attendee_ids)
@@ -855,7 +855,7 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids      = $wpdb->get_results($registration_id_query, ARRAY_A);
+        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
         if (empty($registration_ids)) {
             return [];
         }
@@ -887,7 +887,7 @@ 
     public function event_reg_count_for_statuses(int $EVT_ID, $statuses = []): int
     {
         $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             throw new InvalidArgumentException(
                 esc_html__('An invalid Event ID was supplied.', 'event_espresso')
             );
@@ -897,7 +897,7 @@ 
 
         $valid_reg_statuses = EEM_Registration::reg_statuses();
         foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
+            if ( ! in_array($status, $valid_reg_statuses, true)) {
                 throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
             }
         }

core/db_models/EEM_Term.model.php

Indentation +242 added lines, -242 removed lines

@@ -13,262 +13,262 @@
  */
 class EEM_Term extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item                                            = esc_html__('Term', 'event_espresso');
-        $this->plural_item                                              = esc_html__('Terms', 'event_espresso');
-        $this->_tables                                                  = [
-            'Term' => new EE_Primary_Table('terms', 'term_id'),
-        ];
-        $this->_fields                                                  = [
-            'Term' => [
-                'term_id'    => new EE_Primary_Key_Int_Field('term_id', esc_html__('Term ID', 'event_espresso')),
-                'name'       => new EE_Plain_Text_Field('name', esc_html__('Term Name', 'event_espresso'), false, ''),
-                'slug'       => new EE_Slug_Field('slug', esc_html__('Term Slug', 'event_espresso'), false),
-                'term_group' => new EE_Integer_Field(
-                    'term_group', esc_html__("Term Group", "event_espresso"), false, 0
-                ),
-            ],
-        ];
-        $this->_model_relations                                         = [
-            'Term_Taxonomy' => new EE_Has_Many_Relation(),
-        ];
-        $this->_wp_core_model                                           = true;
-        $path_to_tax_model                                              = 'Term_Taxonomy';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Taxonomy_Protected(
-                $path_to_tax_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
-        $path_to_tax_model                                              = $path_to_tax_model . '.';
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item                                            = esc_html__('Term', 'event_espresso');
+		$this->plural_item                                              = esc_html__('Terms', 'event_espresso');
+		$this->_tables                                                  = [
+			'Term' => new EE_Primary_Table('terms', 'term_id'),
+		];
+		$this->_fields                                                  = [
+			'Term' => [
+				'term_id'    => new EE_Primary_Key_Int_Field('term_id', esc_html__('Term ID', 'event_espresso')),
+				'name'       => new EE_Plain_Text_Field('name', esc_html__('Term Name', 'event_espresso'), false, ''),
+				'slug'       => new EE_Slug_Field('slug', esc_html__('Term Slug', 'event_espresso'), false),
+				'term_group' => new EE_Integer_Field(
+					'term_group', esc_html__("Term Group", "event_espresso"), false, 0
+				),
+			],
+		];
+		$this->_model_relations                                         = [
+			'Term_Taxonomy' => new EE_Has_Many_Relation(),
+		];
+		$this->_wp_core_model                                           = true;
+		$path_to_tax_model                                              = 'Term_Taxonomy';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Taxonomy_Protected(
+				$path_to_tax_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
+		$path_to_tax_model                                              = $path_to_tax_model . '.';
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
+	}
 
 
-    /**
-     * retrieves a list of all EE event categories
-     *
-     * @access public
-     * @param bool $show_uncategorized
-     * @return \EE_Base_Class[]
-     */
-    public function get_all_ee_categories($show_uncategorized = false)
-    {
-        $where_params = [
-            'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
-            'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
-        ];
-        if ($show_uncategorized) {
-            unset($where_params['NOT']);
-        }
-        return EEM_Term::instance()->get_all(
-            [
-                $where_params,
-                'order_by' => ['name' => 'ASC'],
-            ]
-        );
-    }
+	/**
+	 * retrieves a list of all EE event categories
+	 *
+	 * @access public
+	 * @param bool $show_uncategorized
+	 * @return \EE_Base_Class[]
+	 */
+	public function get_all_ee_categories($show_uncategorized = false)
+	{
+		$where_params = [
+			'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
+			'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
+		];
+		if ($show_uncategorized) {
+			unset($where_params['NOT']);
+		}
+		return EEM_Term::instance()->get_all(
+			[
+				$where_params,
+				'order_by' => ['name' => 'ASC'],
+			]
+		);
+	}
 
 
-    /**
-     * retrieves a list of all post_tags associated with an EE CPT
-     *
-     * @access public
-     * @param string $post_type
-     * @return array
-     */
-    public function get_all_CPT_post_tags($post_type = '')
-    {
-        switch ($post_type) {
-            case 'espresso_events':
-                return $this->get_all_event_post_tags();
-                break;
-            case 'espresso_venues':
-                return $this->get_all_venue_post_tags();
-                break;
-            default:
-                $event_tags = $this->get_all_event_post_tags();
-                $venue_tags = $this->get_all_venue_post_tags();
-                return array_merge($event_tags, $venue_tags);
-        }
-    }
+	/**
+	 * retrieves a list of all post_tags associated with an EE CPT
+	 *
+	 * @access public
+	 * @param string $post_type
+	 * @return array
+	 */
+	public function get_all_CPT_post_tags($post_type = '')
+	{
+		switch ($post_type) {
+			case 'espresso_events':
+				return $this->get_all_event_post_tags();
+				break;
+			case 'espresso_venues':
+				return $this->get_all_venue_post_tags();
+				break;
+			default:
+				$event_tags = $this->get_all_event_post_tags();
+				$venue_tags = $this->get_all_venue_post_tags();
+				return array_merge($event_tags, $venue_tags);
+		}
+	}
 
 
-    /**
-     * returns an EE_Term object for the given tag
-     * if it has been utilized by any EE_Events or EE_Venues
-     *
-     * @param string $tag
-     * @return EE_Term|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_post_tag_for_event_or_venue($tag)
-    {
-        $post_tag_results = $this->get_all_wpdb_results(
-            [
-                [
-                    'slug'                   => $tag,
-                    'Term_Taxonomy.taxonomy' => 'post_tag',
-                    'OR'                     => [
-                        'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
-                        'Term_Taxonomy.Event.post_type' => 'espresso_events',
-                    ],
-                ],
-                'default_where_conditions' => 'none',
-                'extra_selects'            => [
-                    'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
-                    'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
-                ],
-                'group_by'                 => [
-                    'event_post_type',
-                    'venue_post_type',
-                ],
-                'limit'                    => 2,
-            ]
-        );
-        if (! $post_tag_results) {
-            return null;
-        }
+	/**
+	 * returns an EE_Term object for the given tag
+	 * if it has been utilized by any EE_Events or EE_Venues
+	 *
+	 * @param string $tag
+	 * @return EE_Term|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_post_tag_for_event_or_venue($tag)
+	{
+		$post_tag_results = $this->get_all_wpdb_results(
+			[
+				[
+					'slug'                   => $tag,
+					'Term_Taxonomy.taxonomy' => 'post_tag',
+					'OR'                     => [
+						'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
+						'Term_Taxonomy.Event.post_type' => 'espresso_events',
+					],
+				],
+				'default_where_conditions' => 'none',
+				'extra_selects'            => [
+					'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
+					'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
+				],
+				'group_by'                 => [
+					'event_post_type',
+					'venue_post_type',
+				],
+				'limit'                    => 2,
+			]
+		);
+		if (! $post_tag_results) {
+			return null;
+		}
 
-        $post_types = [];
-        foreach ((array) $post_tag_results as $row) {
-            if ($row['event_post_type'] === 'espresso_events') {
-                $post_types[] = EEM_Event::instance()->post_type();
-            } elseif ($row['venue_post_type'] === 'espresso_venues') {
-                $post_types[] = EEM_Venue::instance()->post_type();
-            }
-        }
-        $post_tag_row = reset($post_tag_results);
-        $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
-            return null;
-        }
+		$post_types = [];
+		foreach ((array) $post_tag_results as $row) {
+			if ($row['event_post_type'] === 'espresso_events') {
+				$post_types[] = EEM_Event::instance()->post_type();
+			} elseif ($row['venue_post_type'] === 'espresso_venues') {
+				$post_types[] = EEM_Venue::instance()->post_type();
+			}
+		}
+		$post_tag_row = reset($post_tag_results);
+		$post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
+		if (! $post_tag instanceof EE_Term) {
+			return null;
+		}
 
-        if ($post_tag->post_type === null) {
-            $post_tag->post_type = [];
-        }
-        $post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
-        return $post_tag;
-    }
+		if ($post_tag->post_type === null) {
+			$post_tag->post_type = [];
+		}
+		$post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
+		return $post_tag;
+	}
 
 
-    /**
-     * get_all_event_post_tags
-     *
-     * @return EE_Base_Class[]
-     */
-    public function get_all_event_post_tags()
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Event.post_type' => 'espresso_events',
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy.Event'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
-            }
-            $post_tags[ $key ]->post_type[] = 'espresso_events';
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_event_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 */
+	public function get_all_event_post_tags()
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Event.post_type' => 'espresso_events',
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy.Event'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tags[ $key ]->post_type)) {
+				$post_tags[ $key ]->post_type = [];
+			}
+			$post_tags[ $key ]->post_type[] = 'espresso_events';
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * get_all_venue_post_tags
-     *
-     * @return EE_Base_Class[]
-     */
-    public function get_all_venue_post_tags()
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
-            }
-            $post_tags[ $key ]->post_type[] = 'espresso_venues';
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_venue_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 */
+	public function get_all_venue_post_tags()
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Venue.post_type' => 'espresso_venues',
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tags[ $key ]->post_type)) {
+				$post_tags[ $key ]->post_type = [];
+			}
+			$post_tags[ $key ]->post_type[] = 'espresso_venues';
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return terms
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return terms
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -43,44 +43,44 @@ 
         ];
         $this->_wp_core_model                                           = true;
         $path_to_tax_model                                              = 'Term_Taxonomy';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Taxonomy_Protected(
                 $path_to_tax_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
-        $path_to_tax_model                                              = $path_to_tax_model . '.';
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = false;
+        $path_to_tax_model                                              = $path_to_tax_model.'.';
         // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         parent::__construct($timezone);
@@ -172,7 +172,7 @@ 
                 'limit'                    => 2,
             ]
         );
-        if (! $post_tag_results) {
+        if ( ! $post_tag_results) {
             return null;
         }
 
@@ -186,7 +186,7 @@ 
         }
         $post_tag_row = reset($post_tag_results);
         $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
+        if ( ! $post_tag instanceof EE_Term) {
             return null;
         }
 
@@ -216,10 +216,10 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
+            if ( ! isset($post_tags[$key]->post_type)) {
+                $post_tags[$key]->post_type = [];
             }
-            $post_tags[ $key ]->post_type[] = 'espresso_events';
+            $post_tags[$key]->post_type[] = 'espresso_events';
         }
         return $post_tags;
     }
@@ -243,10 +243,10 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
+            if ( ! isset($post_tags[$key]->post_type)) {
+                $post_tags[$key]->post_type = [];
             }
-            $post_tags[ $key ]->post_type[] = 'espresso_venues';
+            $post_tags[$key]->post_type[] = 'espresso_venues';
         }
         return $post_tags;
     }
@@ -265,7 +265,7 @@ 
     {
         if ($model === EEM_Term::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/EEM_CPT_Base.model.php

Indentation +560 added lines, -560 removed lines

@@ -14,564 +14,564 @@
  */
 abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base
 {
-    const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
-
-    /**
-     * @var string post_status_publish - the wp post status for published cpts
-     */
-    const post_status_publish = 'publish';
-
-    /**
-     * @var string post_status_future - the wp post status for scheduled cpts
-     */
-    const post_status_future = 'future';
-
-    /**
-     * @var string post_status_draft - the wp post status for draft cpts
-     */
-    const post_status_draft = 'draft';
-
-    /**
-     * @var string post_status_pending - the wp post status for pending cpts
-     */
-    const post_status_pending = 'pending';
-
-    /**
-     * @var string post_status_private - the wp post status for private cpts
-     */
-    const post_status_private = 'private';
-
-    /**
-     * @var string post_status_trashed - the wp post status for trashed cpts
-     */
-    const post_status_trashed = 'trash';
-
-    /**
-     * This is an array of custom statuses for the given CPT model (modified by children)
-     * format:
-     * array(
-     *        'status_name' => array(
-     *            'label' => esc_html__('Status Name', 'event_espresso'),
-     *            'public' => TRUE //whether a public status or not.
-     *        )
-     * )
-     *
-     * @var array
-     */
-    protected $_custom_stati = [];
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        // adds a relationship to Term_Taxonomy for all these models. For this to work
-        // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
-        // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
-        // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
-        // must also be new EE_HABTM_Relation('Term_Relationship');
-        $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
-        $primary_table_name                      = null;
-        // add  the common _status field to all CPT primary tables.
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $primary_table_name = $alias;
-            }
-        }
-        // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
-                'post_status',
-                esc_html__("Event Status", "event_espresso"),
-                false,
-                'draft'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
-                'to_ping',
-                esc_html__('To Ping', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
-                'pinged',
-                esc_html__('Pinged', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
-                'comment_status',
-                esc_html__('Comment Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
-                'ping_status',
-                esc_html__('Ping Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
-                'post_content_filtered',
-                esc_html__('Post Content Filtered', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_model_relations['Post_Meta'])) {
-            // don't block deletes though because we want to maintain the current behaviour
-            $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
-        }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
-        }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            // it's ok for child classes to specify this, but generally this is more DRY
-            $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function public_event_stati()
-    {
-        // @see wp-includes/post.php
-        return get_post_stati(['public' => true]);
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    '%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
-                    "event_espresso"
-                ),
-                get_called_class()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the field's name that sets the post status
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function post_status_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_called_class(),
-                    get_called_class()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $post_status_field_name                     = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        return $query_params;
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete true to indicate deletion, false to indicate restoration
-     * @param array   $query_params
-     * @return boolean success
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete_or_restore($delete = true, $query_params = [])
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params           = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        $new_status             = $delete ? self::post_status_trashed : 'draft';
-        return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
-    }
-
-
-    /**
-     * meta_table
-     * returns first EE_Secondary_Table table name
-     *
-     * @access public
-     * @return string
-     */
-    public function meta_table()
-    {
-        $meta_table = $this->_get_other_tables();
-        $meta_table = reset($meta_table);
-        return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
-    }
-
-
-    /**
-     * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
-     *
-     * @param bool $all  triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
-     *                   db only fields)
-     * @return array
-     */
-    public function get_meta_table_fields($all = false)
-    {
-        $all_fields = $fields_to_return = [];
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
-            }
-        }
-        if (! $all) {
-            foreach ($all_fields as $name => $obj) {
-                if ($obj instanceof EE_DB_Only_Field_Base) {
-                    continue;
-                }
-                $fields_to_return[] = $name;
-            }
-        } else {
-            $fields_to_return = array_keys($all_fields);
-        }
-        return $fields_to_return;
-    }
-
-
-    /**
-     * Adds an event category with the specified name and description to the specified
-     * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
-     * and adds an entry in the term_relationship if necessary.
-     *
-     * @param EE_CPT_Base $cpt_model_object
-     * @param string      $category_name (used to derive the term slug too)
-     * @param string      $category_description
-     * @param int         $parent_term_taxonomy_id
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category(
-        EE_CPT_Base $cpt_model_object,
-        $category_name,
-        $category_description = '',
-        $parent_term_taxonomy_id = null
-    ) {
-        // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
-        // first, check for a term by the same name or slug
-        $category_slug = sanitize_title($category_name);
-        $term          = EEM_Term::instance()->get_one(
-            [
-                [
-                    'OR'                     => [
-                        'name' => $category_name,
-                        'slug' => $category_slug,
-                    ],
-                    'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
-                ],
-            ]
-        );
-        if (! $term) {
-            $term = EE_Term::new_instance(
-                [
-                    'name' => $category_name,
-                    'slug' => $category_slug,
-                ]
-            );
-            $term->save();
-        }
-        // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
-        $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
-            [
-                [
-                    'term_id'  => $term->ID(),
-                    'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
-                ],
-            ]
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
-            $term_taxonomy = EE_Term_Taxonomy::new_instance(
-                [
-                    'term_id'     => $term->ID(),
-                    'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
-                    'description' => $category_description,
-                    'term_count'  => 1,
-                    'parent'      => $parent_term_taxonomy_id,
-                ]
-            );
-            $term_taxonomy->save();
-        } else {
-            $term_taxonomy->set_count($term_taxonomy->count() + 1);
-            $term_taxonomy->save();
-        }
-        return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * Removed the category specified by name as having a relation to this event.
-     * Does not remove the term or term_taxonomy.
-     *
-     * @param EE_CPT_Base $cpt_model_object_event
-     * @param string      $category_name name of the event category (term)
-     * @return bool
-     */
-    public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
-    {
-        // find the term_taxonomy by that name
-        $term_taxonomy = $this->get_first_related(
-            $cpt_model_object_event,
-            'Term_Taxonomy',
-            [['Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY]]
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if ($term_taxonomy) {
-            $term_taxonomy->set_count($term_taxonomy->count() - 1);
-            $term_taxonomy->save();
-        }
-        return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
-     * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access public
-     * @param int          $id   the ID for the cpt we want the feature image for
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    public function get_feature_image($id, $size = 'thumbnail', $attr = '')
-    {
-        return get_the_post_thumbnail($id, $size, $attr);
-    }
-
-
-    /**
-     * Just a handy way to get the list of post statuses currently registered with WP.
-     *
-     * @return array
-     * @global array $wp_post_statuses set in wp core for storing all the post stati
-     */
-    public function get_post_statuses()
-    {
-        global $wp_post_statuses;
-        $statuses = [];
-        foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
-        }
-        return $statuses;
-    }
-
-
-    /**
-     * public method that can be used to retrieve the protected status array on the instantiated cpt model
-     *
-     * @return array array of statuses.
-     */
-    public function get_status_array()
-    {
-        $statuses = $this->get_post_statuses();
-        // first the global filter
-        $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
-        // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
-        return $statuses;
-    }
-
-
-    /**
-     * this returns the post statuses that are NOT the default wordpress status
-     *
-     * @return array
-     */
-    public function get_custom_post_statuses()
-    {
-        $new_stati = [];
-        foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
-        }
-        return $new_stati;
-    }
-
-
-    /**
-     * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
-     * are a row from the posts table. If we're missing any fields required for the model,
-     * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
-     * make sure you are attaching all the model's fields onto the post)
-     *
-     * @param WP_Post|array $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object_orig($post)
-    {
-        $post                               = (array) $post;
-        $has_all_necessary_fields_for_table = true;
-        // check if the post has fields on the meta table already
-        foreach ($this->_get_other_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $has_all_necessary_fields_for_table = false;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
-            return $this->get_one_by_ID($post['ID']);
-        } else {
-            return $this->instantiate_class_from_array_or_object($post);
-        }
-    }
-
-
-    /**
-     * @param null $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object($post = null)
-    {
-        if (empty($post)) {
-            global $post;
-        }
-        $post                         = (array) $post;
-        $tables_needing_to_be_queried = [];
-        // check if the post has fields on the meta table already
-        foreach ($this->get_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if ($tables_needing_to_be_queried) {
-            if (
-                count($tables_needing_to_be_queried) == 1
-                && reset($tables_needing_to_be_queried)
-                   instanceof
-                   EE_Secondary_Table
-            ) {
-                // so we're only missing data from a secondary table. Well that's not too hard to query for
-                $table_to_query = reset($tables_needing_to_be_queried);
-                $missing_data   = $this->_do_wpdb_query(
-                    'get_row',
-                    [
-                        'SELECT * FROM '
-                        . $table_to_query->get_table_name()
-                        . ' WHERE '
-                        . $table_to_query->get_fk_on_table()
-                        . ' = '
-                        . $post['ID'],
-                        ARRAY_A,
-                    ]
-                );
-                if (! empty($missing_data)) {
-                    $post = array_merge($post, $missing_data);
-                }
-            } else {
-                return $this->get_one_by_ID($post['ID']);
-            }
-        }
-        return $this->instantiate_class_from_array_or_object($post);
-    }
-
-
-    /**
-     * Gets the post type associated with this
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function post_type()
-    {
-        $post_type_field = null;
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_WP_Post_Type_Field) {
-                $post_type_field = $field_obj;
-                break;
-            }
-        }
-        if ($post_type_field == null) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $post_type_field->get_default_value();
-    }
+	const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
+
+	/**
+	 * @var string post_status_publish - the wp post status for published cpts
+	 */
+	const post_status_publish = 'publish';
+
+	/**
+	 * @var string post_status_future - the wp post status for scheduled cpts
+	 */
+	const post_status_future = 'future';
+
+	/**
+	 * @var string post_status_draft - the wp post status for draft cpts
+	 */
+	const post_status_draft = 'draft';
+
+	/**
+	 * @var string post_status_pending - the wp post status for pending cpts
+	 */
+	const post_status_pending = 'pending';
+
+	/**
+	 * @var string post_status_private - the wp post status for private cpts
+	 */
+	const post_status_private = 'private';
+
+	/**
+	 * @var string post_status_trashed - the wp post status for trashed cpts
+	 */
+	const post_status_trashed = 'trash';
+
+	/**
+	 * This is an array of custom statuses for the given CPT model (modified by children)
+	 * format:
+	 * array(
+	 *        'status_name' => array(
+	 *            'label' => esc_html__('Status Name', 'event_espresso'),
+	 *            'public' => TRUE //whether a public status or not.
+	 *        )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_custom_stati = [];
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		// adds a relationship to Term_Taxonomy for all these models. For this to work
+		// Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
+		// eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
+		// with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
+		// must also be new EE_HABTM_Relation('Term_Relationship');
+		$this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
+		$primary_table_name                      = null;
+		// add  the common _status field to all CPT primary tables.
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$primary_table_name = $alias;
+			}
+		}
+		// set default wp post statuses if child has not already set.
+		if (! isset($this->_fields[ $primary_table_name ]['status'])) {
+			$this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+				'post_status',
+				esc_html__("Event Status", "event_espresso"),
+				false,
+				'draft'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
+			$this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+				'to_ping',
+				esc_html__('To Ping', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
+			$this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+				'pinged',
+				esc_html__('Pinged', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
+			$this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+				'comment_status',
+				esc_html__('Comment Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
+			$this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+				'ping_status',
+				esc_html__('Ping Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
+			$this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+				'post_content_filtered',
+				esc_html__('Post Content Filtered', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_model_relations['Post_Meta'])) {
+			// don't block deletes though because we want to maintain the current behaviour
+			$this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
+		}
+		if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
+		}
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			// it's ok for child classes to specify this, but generally this is more DRY
+			$this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function public_event_stati()
+	{
+		// @see wp-includes/post.php
+		return get_post_stati(['public' => true]);
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
+					"event_espresso"
+				),
+				get_called_class()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the field's name that sets the post status
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function post_status_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_called_class(),
+					get_called_class()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$post_status_field_name                     = $this->post_status_field_name();
+		$query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		return $query_params;
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete_or_restore($delete = true, $query_params = [])
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params           = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		$new_status             = $delete ? self::post_status_trashed : 'draft';
+		return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
+	}
+
+
+	/**
+	 * meta_table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function meta_table()
+	{
+		$meta_table = $this->_get_other_tables();
+		$meta_table = reset($meta_table);
+		return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
+	 *
+	 * @param bool $all  triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
+	 *                   db only fields)
+	 * @return array
+	 */
+	public function get_meta_table_fields($all = false)
+	{
+		$all_fields = $fields_to_return = [];
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
+			}
+		}
+		if (! $all) {
+			foreach ($all_fields as $name => $obj) {
+				if ($obj instanceof EE_DB_Only_Field_Base) {
+					continue;
+				}
+				$fields_to_return[] = $name;
+			}
+		} else {
+			$fields_to_return = array_keys($all_fields);
+		}
+		return $fields_to_return;
+	}
+
+
+	/**
+	 * Adds an event category with the specified name and description to the specified
+	 * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
+	 * and adds an entry in the term_relationship if necessary.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object
+	 * @param string      $category_name (used to derive the term slug too)
+	 * @param string      $category_description
+	 * @param int         $parent_term_taxonomy_id
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category(
+		EE_CPT_Base $cpt_model_object,
+		$category_name,
+		$category_description = '',
+		$parent_term_taxonomy_id = null
+	) {
+		// create term
+		require_once(EE_MODELS . 'EEM_Term.model.php');
+		// first, check for a term by the same name or slug
+		$category_slug = sanitize_title($category_name);
+		$term          = EEM_Term::instance()->get_one(
+			[
+				[
+					'OR'                     => [
+						'name' => $category_name,
+						'slug' => $category_slug,
+					],
+					'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
+				],
+			]
+		);
+		if (! $term) {
+			$term = EE_Term::new_instance(
+				[
+					'name' => $category_name,
+					'slug' => $category_slug,
+				]
+			);
+			$term->save();
+		}
+		// make sure there's a term-taxonomy entry too
+		require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+		$term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
+			[
+				[
+					'term_id'  => $term->ID(),
+					'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
+				],
+			]
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if (! $term_taxonomy) {
+			$term_taxonomy = EE_Term_Taxonomy::new_instance(
+				[
+					'term_id'     => $term->ID(),
+					'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
+					'description' => $category_description,
+					'term_count'  => 1,
+					'parent'      => $parent_term_taxonomy_id,
+				]
+			);
+			$term_taxonomy->save();
+		} else {
+			$term_taxonomy->set_count($term_taxonomy->count() + 1);
+			$term_taxonomy->save();
+		}
+		return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * Removed the category specified by name as having a relation to this event.
+	 * Does not remove the term or term_taxonomy.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object_event
+	 * @param string      $category_name name of the event category (term)
+	 * @return bool
+	 */
+	public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
+	{
+		// find the term_taxonomy by that name
+		$term_taxonomy = $this->get_first_related(
+			$cpt_model_object_event,
+			'Term_Taxonomy',
+			[['Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY]]
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if ($term_taxonomy) {
+			$term_taxonomy->set_count($term_taxonomy->count() - 1);
+			$term_taxonomy->save();
+		}
+		return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
+	 * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access public
+	 * @param int          $id   the ID for the cpt we want the feature image for
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	public function get_feature_image($id, $size = 'thumbnail', $attr = '')
+	{
+		return get_the_post_thumbnail($id, $size, $attr);
+	}
+
+
+	/**
+	 * Just a handy way to get the list of post statuses currently registered with WP.
+	 *
+	 * @return array
+	 * @global array $wp_post_statuses set in wp core for storing all the post stati
+	 */
+	public function get_post_statuses()
+	{
+		global $wp_post_statuses;
+		$statuses = [];
+		foreach ($wp_post_statuses as $post_status => $args_object) {
+			$statuses[ $post_status ] = $args_object->label;
+		}
+		return $statuses;
+	}
+
+
+	/**
+	 * public method that can be used to retrieve the protected status array on the instantiated cpt model
+	 *
+	 * @return array array of statuses.
+	 */
+	public function get_status_array()
+	{
+		$statuses = $this->get_post_statuses();
+		// first the global filter
+		$statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
+		// now the class specific filter
+		$statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+		return $statuses;
+	}
+
+
+	/**
+	 * this returns the post statuses that are NOT the default wordpress status
+	 *
+	 * @return array
+	 */
+	public function get_custom_post_statuses()
+	{
+		$new_stati = [];
+		foreach ($this->_custom_stati as $status => $props) {
+			$new_stati[ $status ] = $props['label'];
+		}
+		return $new_stati;
+	}
+
+
+	/**
+	 * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
+	 * are a row from the posts table. If we're missing any fields required for the model,
+	 * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
+	 * make sure you are attaching all the model's fields onto the post)
+	 *
+	 * @param WP_Post|array $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object_orig($post)
+	{
+		$post                               = (array) $post;
+		$has_all_necessary_fields_for_table = true;
+		// check if the post has fields on the meta table already
+		foreach ($this->_get_other_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$has_all_necessary_fields_for_table = false;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if (! $has_all_necessary_fields_for_table) {
+			return $this->get_one_by_ID($post['ID']);
+		} else {
+			return $this->instantiate_class_from_array_or_object($post);
+		}
+	}
+
+
+	/**
+	 * @param null $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object($post = null)
+	{
+		if (empty($post)) {
+			global $post;
+		}
+		$post                         = (array) $post;
+		$tables_needing_to_be_queried = [];
+		// check if the post has fields on the meta table already
+		foreach ($this->get_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if ($tables_needing_to_be_queried) {
+			if (
+				count($tables_needing_to_be_queried) == 1
+				&& reset($tables_needing_to_be_queried)
+				   instanceof
+				   EE_Secondary_Table
+			) {
+				// so we're only missing data from a secondary table. Well that's not too hard to query for
+				$table_to_query = reset($tables_needing_to_be_queried);
+				$missing_data   = $this->_do_wpdb_query(
+					'get_row',
+					[
+						'SELECT * FROM '
+						. $table_to_query->get_table_name()
+						. ' WHERE '
+						. $table_to_query->get_fk_on_table()
+						. ' = '
+						. $post['ID'],
+						ARRAY_A,
+					]
+				);
+				if (! empty($missing_data)) {
+					$post = array_merge($post, $missing_data);
+				}
+			} else {
+				return $this->get_one_by_ID($post['ID']);
+			}
+		}
+		return $this->instantiate_class_from_array_or_object($post);
+	}
+
+
+	/**
+	 * Gets the post type associated with this
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function post_type()
+	{
+		$post_type_field = null;
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_WP_Post_Type_Field) {
+				$post_type_field = $field_obj;
+				break;
+			}
+		}
+		if ($post_type_field == null) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $post_type_field->get_default_value();
+	}
 }

Spacing +31 added lines, -31 removed lines

@@ -81,63 +81,63 @@ 
             }
         }
         // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['status'])) {
+            $this->_fields[$primary_table_name]['status'] = new EE_WP_Post_Status_Field(
                 'post_status',
                 esc_html__("Event Status", "event_espresso"),
                 false,
                 'draft'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['to_ping'])) {
+            $this->_fields[$primary_table_name]['to_ping'] = new EE_DB_Only_Text_Field(
                 'to_ping',
                 esc_html__('To Ping', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['pinged'])) {
+            $this->_fields[$primary_table_name]['pinged'] = new EE_DB_Only_Text_Field(
                 'pinged',
                 esc_html__('Pinged', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['comment_status'])) {
+            $this->_fields[$primary_table_name]['comment_status'] = new EE_Plain_Text_Field(
                 'comment_status',
                 esc_html__('Comment Status', 'event_espresso'),
                 false,
                 'open'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['ping_status'])) {
+            $this->_fields[$primary_table_name]['ping_status'] = new EE_Plain_Text_Field(
                 'ping_status',
                 esc_html__('Ping Status', 'event_espresso'),
                 false,
                 'open'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['post_content_filtered'])) {
+            $this->_fields[$primary_table_name]['post_content_filtered'] = new EE_DB_Only_Text_Field(
                 'post_content_filtered',
                 esc_html__('Post Content Filtered', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_model_relations['Post_Meta'])) {
+        if ( ! isset($this->_model_relations['Post_Meta'])) {
             // don't block deletes though because we want to maintain the current behaviour
             $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
         }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             // nothing was set during child constructor, so set default
             $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
         }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             // nothing was set during child constructor, so set default
             // it's ok for child classes to specify this, but generally this is more DRY
             $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
@@ -214,7 +214,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $post_status_field_name                     = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+        $query_params[0][$post_status_field_name] = self::post_status_trashed;
         return $query_params;
     }
 
@@ -280,7 +280,7 @@ 
                 $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
             }
         }
-        if (! $all) {
+        if ( ! $all) {
             foreach ($all_fields as $name => $obj) {
                 if ($obj instanceof EE_DB_Only_Field_Base) {
                     continue;
@@ -312,7 +312,7 @@ 
         $parent_term_taxonomy_id = null
     ) {
         // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
+        require_once(EE_MODELS.'EEM_Term.model.php');
         // first, check for a term by the same name or slug
         $category_slug = sanitize_title($category_name);
         $term          = EEM_Term::instance()->get_one(
@@ -326,7 +326,7 @@ 
                 ],
             ]
         );
-        if (! $term) {
+        if ( ! $term) {
             $term = EE_Term::new_instance(
                 [
                     'name' => $category_name,
@@ -336,7 +336,7 @@ 
             $term->save();
         }
         // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+        require_once(EE_MODELS.'EEM_Term_Taxonomy.model.php');
         $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
             [
                 [
@@ -346,7 +346,7 @@ 
             ]
         );
         /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             $term_taxonomy = EE_Term_Taxonomy::new_instance(
                 [
                     'term_id'     => $term->ID(),
@@ -419,7 +419,7 @@ 
         global $wp_post_statuses;
         $statuses = [];
         foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
+            $statuses[$post_status] = $args_object->label;
         }
         return $statuses;
     }
@@ -436,7 +436,7 @@ 
         // first the global filter
         $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
         // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+        $statuses = apply_filters('FHEE_EEM_'.get_class($this).'__get_status_array', $statuses);
         return $statuses;
     }
 
@@ -450,7 +450,7 @@ 
     {
         $new_stati = [];
         foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
+            $new_stati[$status] = $props['label'];
         }
         return $new_stati;
     }
@@ -474,15 +474,15 @@ 
             $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
             foreach ($fields_for_that_table as $field_obj) {
                 if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
+                    ! isset($post[$field_obj->get_table_column()])
+                    && ! isset($post[$field_obj->get_qualified_column()])
                 ) {
                     $has_all_necessary_fields_for_table = false;
                 }
             }
         }
         // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
+        if ( ! $has_all_necessary_fields_for_table) {
             return $this->get_one_by_ID($post['ID']);
         } else {
             return $this->instantiate_class_from_array_or_object($post);
@@ -506,10 +506,10 @@ 
             $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
             foreach ($fields_for_that_table as $field_obj) {
                 if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
+                    ! isset($post[$field_obj->get_table_column()])
+                    && ! isset($post[$field_obj->get_qualified_column()])
                 ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+                    $tables_needing_to_be_queried[$table_obj->get_table_alias()] = $table_obj;
                 }
             }
         }
@@ -535,7 +535,7 @@ 
                         ARRAY_A,
                     ]
                 );
-                if (! empty($missing_data)) {
+                if ( ! empty($missing_data)) {
                     $post = array_merge($post, $missing_data);
                 }
             } else {

core/db_models/EEM_Extra_Join.model.php

Indentation +66 added lines, -66 removed lines

@@ -19,73 +19,73 @@
  */
 class EEM_Extra_Join extends EEM_Base
 {
-    // private instance of the Extra Join object
-    protected static $_instance = null;
+	// private instance of the Extra Join object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    public function __construct(?string $timezone = '')
-    {
-        $models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_tables        = [
-            'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
-        ];
-        $this->_fields        = [
-            'Extra_Join' => [
-                'EXJ_ID'                => new EE_Primary_Key_Int_Field(
-                    'EXJ_ID',
-                    esc_html__('Extra Join ID', 'event_espresso')
-                ),
-                'EXJ_first_model_ID'    => new EE_Foreign_Key_String_Field(
-                    'EXJ_first_model_ID',
-                    esc_html__('First Model ID', 'event_espresso'),
-                    true,
-                    0,
-                    $models_this_can_join
-                ),
-                'EXJ_first_model_name'  => new EE_Any_Foreign_Model_Name_Field(
-                    'EXJ_first_model_name',
-                    esc_html__(
-                        'First Model Name',
-                        'event_espresso'
-                    ),
-                    true,
-                    '',
-                    $models_this_can_join
-                ),
-                'EXJ_second_model_ID'   => new EE_Foreign_Key_String_Field(
-                    'EXJ_second_model_ID',
-                    esc_html__(
-                        'Second Model ID',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    $models_this_can_join
-                ),
-                'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field(
-                    'EXJ_second_model_name',
-                    esc_html__(
-                        'Second Model Name',
-                        'event_espresso'
-                    ),
-                    true,
-                    '',
-                    $models_this_can_join
-                ),
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	public function __construct(?string $timezone = '')
+	{
+		$models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_tables        = [
+			'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
+		];
+		$this->_fields        = [
+			'Extra_Join' => [
+				'EXJ_ID'                => new EE_Primary_Key_Int_Field(
+					'EXJ_ID',
+					esc_html__('Extra Join ID', 'event_espresso')
+				),
+				'EXJ_first_model_ID'    => new EE_Foreign_Key_String_Field(
+					'EXJ_first_model_ID',
+					esc_html__('First Model ID', 'event_espresso'),
+					true,
+					0,
+					$models_this_can_join
+				),
+				'EXJ_first_model_name'  => new EE_Any_Foreign_Model_Name_Field(
+					'EXJ_first_model_name',
+					esc_html__(
+						'First Model Name',
+						'event_espresso'
+					),
+					true,
+					'',
+					$models_this_can_join
+				),
+				'EXJ_second_model_ID'   => new EE_Foreign_Key_String_Field(
+					'EXJ_second_model_ID',
+					esc_html__(
+						'Second Model ID',
+						'event_espresso'
+					),
+					true,
+					0,
+					$models_this_can_join
+				),
+				'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field(
+					'EXJ_second_model_name',
+					esc_html__(
+						'Second Model Name',
+						'event_espresso'
+					),
+					true,
+					'',
+					$models_this_can_join
+				),
 
-            ],
-        ];
-        // this model is weird in that it has two foreign key columns which can point to any model/table.
-        // eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
-        // model linked to is alphabetically greater than event (eg venue).
-        // but if the model linked to is alphabetically lower (eg attendee),
-        // the foreign key to the event will be in "EXJ_second_model_ID"
-        // so normal usage of foreign keys is weird. So don't define any
-        // relations to other models because they won't work properly with this model
-        parent::__construct($timezone);
-    }
+			],
+		];
+		// this model is weird in that it has two foreign key columns which can point to any model/table.
+		// eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
+		// model linked to is alphabetically greater than event (eg venue).
+		// but if the model linked to is alphabetically lower (eg attendee),
+		// the foreign key to the event will be in "EXJ_second_model_ID"
+		// so normal usage of foreign keys is weird. So don't define any
+		// relations to other models because they won't work properly with this model
+		parent::__construct($timezone);
+	}
 }