eventespresso / event-espresso-core

core/db_classes/EE_CPT_Base.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -35,7 +35,7 @@ 
      *
      * @param string      $category_name
      * @param string|null $category_description    optional
-     * @param int|null    $parent_term_taxonomy_id optional
+     * @param integer    $parent_term_taxonomy_id optional
      * @return EE_Term_Taxonomy
      * @throws EE_Error
      * @throws ReflectionException
@@ -170,7 +170,7 @@ 
      *
      * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
      * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+     * @param string $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
@@ -215,7 +215,7 @@ 
      * This is a method for restoring this_obj using details from the given $revision_id
      *
      * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
+     * @param string[] $related_obj_names if included this will be used to restore for related obj
      *                                 if not included then we just do restore on the meta.
      *                                 We will accept an array of related_obj_names for restoration here.
      * @param array $where_query       You can optionally include an array of key=>value pairs
@@ -280,7 +280,7 @@ 
      *
      * @param string $meta_key
      * @param bool   $single
-     * @return mixed
+     * @return null|string
      * @throws EE_Error
      */
     public function get_post_meta(string $meta_key = '', bool $single = false)
@@ -316,7 +316,7 @@ 
      * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
      *
      * @param string $meta_key
-     * @param mixed $meta_value
+     * @param string $meta_value
      * @param bool  $unique     If postmeta for this $meta_key already exists,
      *                          whether to add an additional item or not
      * @return boolean          Boolean true, except if the $unique argument was set to true

Indentation +482 added lines, -482 removed lines

@@ -12,486 +12,486 @@
 abstract class EE_CPT_Base extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * This is a property for holding cached feature images on CPT objects.
-     * Cache's are set on the first "feature_image()" method call.
-     * Each key in the array corresponds to the requested size.
-     *
-     * @var array
-     */
-    protected $_feature_image = [];
-
-    /**
-     * @var WP_Post the WP_Post that corresponds with this CPT model object
-     */
-    protected $_wp_post;
-
-
-    abstract public function wp_user();
-
-
-    /**
-     * Adds to the specified event category. If it category doesn't exist, creates it.
-     *
-     * @param string      $category_name
-     * @param string|null $category_description    optional
-     * @param int|null    $parent_term_taxonomy_id optional
-     * @return EE_Term_Taxonomy
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_event_category(
-        string $category_name,
-        string $category_description = '',
-        int $parent_term_taxonomy_id = 0
-    ): EE_Term_Taxonomy {
-        return $this->get_model()->add_event_category(
-            $this,
-            $category_name,
-            $category_description,
-            $parent_term_taxonomy_id
-        );
-    }
-
-
-    /**
-     * Removes the event category by specified name from being related ot this event
-     *
-     * @param string $category_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_event_category(string $category_name): bool
-    {
-        return $this->get_model()->remove_event_category($this, $category_name);
-    }
-
-
-    /**
-     * Removes the relation to the specified term taxonomy, and maintains the
-     * data integrity of the term taxonomy provided
-     *
-     * @param EE_Term_Taxonomy $term_taxonomy
-     * @return EE_Base_Class the relation was removed from
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_relation_to_term_taxonomy(EE_Term_Taxonomy $term_taxonomy): ?EE_Base_Class
-    {
-        if (! $term_taxonomy) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        "No Term_Taxonomy provided which to remove from model object of type %s and id %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $term_taxonomy->set_count($term_taxonomy->count() - 1);
-        $term_taxonomy->save();
-        return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * The main purpose of this method is to return the post type for the model object
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function post_type(): string
-    {
-        return $this->get_model()->post_type();
-    }
-
-
-    /**
-     * The main purpose of this method is to return the parent for the model object
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function parent(): int
-    {
-        return $this->get('parent');
-    }
-
-
-    /**
-     * return the _status property
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function status(): string
-    {
-        return $this->get('status');
-    }
-
-
-    /**
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_status(string $status)
-    {
-        $this->set('status', $status);
-    }
-
-
-    /**
-     * See _get_feature_image. Returns the HTML to display a featured image
-     *
-     * @param string       $size
-     * @param string|array $attr
-     * @return string of html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function feature_image(string $size = 'thumbnail', $attr = ''): string
-    {
-        return $this->_get_feature_image($size, $attr);
-    }
-
-
-    /**
-     * This calls the equivalent model method for retrieving the feature image
-     * which in turn is a wrapper for WordPress' get_the_post_thumbnail() function.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access protected
-     * @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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_feature_image($size, $attr): string
-    {
-        // first let's see if we already have the _feature_image property set
-        // AND if it has a cached element on it FOR the given size
-        $attr_key                           = is_array($attr)
-            ? implode('_', $attr)
-            : $attr;
-        $cache_key                          = is_array($size)
-            ? implode('_', $size) . $attr_key
-            : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = $this->_feature_image[ $cache_key ]
-                                              ?? $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
-    }
-
-
-    /**
-     * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
-     * using the given size params.
-     *
-     * @param string|array $size  can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
-     *                            representing width and height in pixels eg. array(32,32).
-     * @return string|boolean          the url of the image or false if not found
-     * @throws EE_Error
-     */
-    public function feature_image_url($size = 'thumbnail')
-    {
-        $attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
-        return ! empty($attachment)
-            ? $attachment[0]
-            : false;
-    }
-
-
-    /**
-     * This is a method for restoring this_obj using details from the given $revision_id
-     *
-     * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
-     *                                 if not included then we just do restore on the meta.
-     *                                 We will accept an array of related_obj_names for restoration here.
-     * @param array $where_query       You can optionally include an array of key=>value pairs
-     *                                 that allow you to further constrict the relation to being added.
-     *                                 However, keep in mind that the columns (keys) given
-     *                                 must match a column on the JOIN table and currently
-     *                                 only the HABTM models accept these additional conditions.
-     *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
-     *                                 then a NEW row is created in the join table.
-     *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
-     *                                 sent);
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_revision(int $revision_id, array $related_obj_names = [], array $where_query = [])
-    {
-        // get revision object
-        $revision_obj = $this->get_model()->get_one_by_ID($revision_id);
-        if ($revision_obj instanceof EE_CPT_Base) {
-            // no related_obj_name so we assume we're saving a revision on this object.
-            if (empty($related_obj_names)) {
-                $fields = $this->get_model()->get_meta_table_fields();
-                foreach ($fields as $field) {
-                    $this->set($field, $revision_obj->get($field));
-                }
-                $this->save();
-            }
-            foreach ($related_obj_names as $related_name) {
-                // related_obj_name so we're saving a revision on an object related to this object
-                // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values         = $where_query[ $related_name ] ?? [];
-                $where_params          = ! empty($cols_n_values)
-                    ? [$cols_n_values]
-                    : [];
-                $related_objs          = $this->get_many_related($related_name, $where_params);
-                $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
-                // load helper
-                // remove related objs from this object that are not in revision
-                // array_diff *should* work cause I think objects are indexed by ID?
-                $related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
-                foreach ($related_to_remove as $rr) {
-                    $this->_remove_relation_to($rr, $related_name, $cols_n_values);
-                }
-                // add all related objs attached to revision to this object
-                foreach ($revision_related_objs as $r_obj) {
-                    $this->_add_relation_to($r_obj, $related_name, $cols_n_values);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
-     * If only $id is set:
-     *  it will return all meta values in an associative array.
-     * If $single is set to false, or left blank:
-     *  the function returns an array containing all values of the specified key.
-     * If $single is set to true:
-     *  the function returns the first value of the specified key (not in an array)
-     *
-     * @param string $meta_key
-     * @param bool   $single
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function get_post_meta(string $meta_key = '', bool $single = false)
-    {
-        return get_post_meta($this->ID(), $meta_key, $single);
-    }
-
-
-    /**
-     * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
-     * Returns meta_id if the meta doesn't exist,
-     * otherwise returns true on success and false on failure.
-     * NOTE: If the meta_value passed to this function is the same
-     * as the value that is already in the database, this function returns false.
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $prev_value
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_post_meta(string $meta_key, $meta_value, $prev_value = null)
-    {
-        if (! $this->ID()) {
-            $this->save();
-        }
-        return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
-    }
-
-
-    /**
-     * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-     *
-     * @param string $meta_key
-     * @param mixed $meta_value
-     * @param bool  $unique     If postmeta for this $meta_key already exists,
-     *                          whether to add an additional item or not
-     * @return boolean          Boolean true, except if the $unique argument was set to true
-     *                          and a custom field with the given key already exists,
-     *                          in which case false is returned.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_post_meta(string $meta_key, $meta_value, bool $unique = false): bool
-    {
-        if ($this->ID()) {
-            $this->save();
-        }
-        return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
-    }
-
-
-    /**
-     * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
-     *
-     * @param string $meta_key
-     * @param mixed $meta_value
-     * @return boolean False for failure. True for success.
-     * @throws EE_Error
-     */
-    public function delete_post_meta(string $meta_key, $meta_value = ''): bool
-    {
-        if (! $this->ID()) {
-            // there is obviously no postmeta for this if it's not saved
-            // so let's just report this as a success
-            return true;
-        }
-        return delete_post_meta($this->ID(), $meta_key, $meta_value);
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink(): string
-    {
-        return get_permalink($this->ID());
-    }
-
-
-    /**
-     * Gets all the term-taxonomies for this CPT
-     *
-     * @param array $query_params
-     * @return EE_Term_Taxonomy[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function term_taxonomies(array $query_params = []): array
-    {
-        return $this->get_many_related('Term_Taxonomy', $query_params);
-    }
-
-
-    /**
-     * @return string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_custom_post_statuses(): array
-    {
-        return $this->get_model()->get_custom_post_statuses();
-    }
-
-
-    /**
-     * @return string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_post_statuses(): array
-    {
-        return $this->get_model()->get_status_array();
-    }
-
-
-    /**
-     * When fetching a new value for a post field that uses the global $post for rendering,
-     * set the global $post temporarily to be this model object; and afterwards restore it
-     *
-     * @param string      $field_name
-     * @param bool        $pretty
-     * @param string|null $extra_cache_ref
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_fresh_property(string $field_name, bool $pretty = false, string $extra_cache_ref = '')
-    {
-        global $post;
-
-        if (
-            $pretty
-            && (
-                ! ($post instanceof WP_Post && $post->ID)
-                || absint($post->ID) !== $this->ID()
-            )
-            && $this->get_model()->field_settings_for($field_name) instanceof EE_Post_Content_Field
-        ) {
-            $old_post     = $post;
-            $post         = $this->wp_post();
-            $return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
-            $post         = $old_post;
-        } else {
-            $return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
-        }
-        return $return_value;
-    }
-
-
-    /**
-     * Returns the WP post associated with this CPT model object.
-     * If this CPT is saved, fetches it from the DB.
-     * Otherwise, create an unsaved WP_POst object. Caches the post internally.
-     *
-     * @return WP_Post
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_post(): WP_Post
-    {
-        global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
-            if ($this->ID()) {
-                $this->_wp_post = get_post($this->ID());
-            } else {
-                $simulated_db_result = new stdClass();
-                $field_settings      = $this->get_model()->field_settings(true);
-                foreach ($field_settings as $field_name => $field_obj) {
-                    if (
-                        $this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())
-                             ->get_table_name() === $wpdb->posts
-                    ) {
-                        $column = $field_obj->get_table_column();
-
-                        if ($field_obj instanceof EE_Datetime_Field) {
-                            $value_on_model_obj = $this->get_DateTime_object($field_name);
-                        } elseif ($field_obj->is_db_only_field()) {
-                            $value_on_model_obj = $field_obj->get_default_value();
-                        } else {
-                            $value_on_model_obj = $this->get_raw($field_name);
-                        }
-                        $simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
-                    }
-                }
-                $this->_wp_post = new WP_Post($simulated_db_result);
-            }
-            // and let's make retrieving the EE CPT object easy too
-            $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
-                $this->_wp_post->{$classname} = $this;
-            }
-        }
-        return $this->_wp_post;
-    }
-
-
-    /**
-     * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __sleep()
-    {
-        $properties_to_serialize = parent::__sleep();
-        return array_diff($properties_to_serialize, ['_wp_post']);
-    }
+	/**
+	 * This is a property for holding cached feature images on CPT objects.
+	 * Cache's are set on the first "feature_image()" method call.
+	 * Each key in the array corresponds to the requested size.
+	 *
+	 * @var array
+	 */
+	protected $_feature_image = [];
+
+	/**
+	 * @var WP_Post the WP_Post that corresponds with this CPT model object
+	 */
+	protected $_wp_post;
+
+
+	abstract public function wp_user();
+
+
+	/**
+	 * Adds to the specified event category. If it category doesn't exist, creates it.
+	 *
+	 * @param string      $category_name
+	 * @param string|null $category_description    optional
+	 * @param int|null    $parent_term_taxonomy_id optional
+	 * @return EE_Term_Taxonomy
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_event_category(
+		string $category_name,
+		string $category_description = '',
+		int $parent_term_taxonomy_id = 0
+	): EE_Term_Taxonomy {
+		return $this->get_model()->add_event_category(
+			$this,
+			$category_name,
+			$category_description,
+			$parent_term_taxonomy_id
+		);
+	}
+
+
+	/**
+	 * Removes the event category by specified name from being related ot this event
+	 *
+	 * @param string $category_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_event_category(string $category_name): bool
+	{
+		return $this->get_model()->remove_event_category($this, $category_name);
+	}
+
+
+	/**
+	 * Removes the relation to the specified term taxonomy, and maintains the
+	 * data integrity of the term taxonomy provided
+	 *
+	 * @param EE_Term_Taxonomy $term_taxonomy
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_relation_to_term_taxonomy(EE_Term_Taxonomy $term_taxonomy): ?EE_Base_Class
+	{
+		if (! $term_taxonomy) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						"No Term_Taxonomy provided which to remove from model object of type %s and id %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
+		$term_taxonomy->save();
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the post type for the model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function post_type(): string
+	{
+		return $this->get_model()->post_type();
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the parent for the model object
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function parent(): int
+	{
+		return $this->get('parent');
+	}
+
+
+	/**
+	 * return the _status property
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function status(): string
+	{
+		return $this->get('status');
+	}
+
+
+	/**
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_status(string $status)
+	{
+		$this->set('status', $status);
+	}
+
+
+	/**
+	 * See _get_feature_image. Returns the HTML to display a featured image
+	 *
+	 * @param string       $size
+	 * @param string|array $attr
+	 * @return string of html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function feature_image(string $size = 'thumbnail', $attr = ''): string
+	{
+		return $this->_get_feature_image($size, $attr);
+	}
+
+
+	/**
+	 * This calls the equivalent model method for retrieving the feature image
+	 * which in turn is a wrapper for WordPress' get_the_post_thumbnail() function.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access protected
+	 * @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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_feature_image($size, $attr): string
+	{
+		// first let's see if we already have the _feature_image property set
+		// AND if it has a cached element on it FOR the given size
+		$attr_key                           = is_array($attr)
+			? implode('_', $attr)
+			: $attr;
+		$cache_key                          = is_array($size)
+			? implode('_', $size) . $attr_key
+			: $size . $attr_key;
+		$this->_feature_image[ $cache_key ] = $this->_feature_image[ $cache_key ]
+											  ?? $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[ $cache_key ];
+	}
+
+
+	/**
+	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
+	 * using the given size params.
+	 *
+	 * @param string|array $size  can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
+	 *                            representing width and height in pixels eg. array(32,32).
+	 * @return string|boolean          the url of the image or false if not found
+	 * @throws EE_Error
+	 */
+	public function feature_image_url($size = 'thumbnail')
+	{
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment)
+			? $attachment[0]
+			: false;
+	}
+
+
+	/**
+	 * This is a method for restoring this_obj using details from the given $revision_id
+	 *
+	 * @param int   $revision_id       ID of the revision we're getting data from
+	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 *                                 if not included then we just do restore on the meta.
+	 *                                 We will accept an array of related_obj_names for restoration here.
+	 * @param array $where_query       You can optionally include an array of key=>value pairs
+	 *                                 that allow you to further constrict the relation to being added.
+	 *                                 However, keep in mind that the columns (keys) given
+	 *                                 must match a column on the JOIN table and currently
+	 *                                 only the HABTM models accept these additional conditions.
+	 *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
+	 *                                 then a NEW row is created in the join table.
+	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
+	 *                                 sent);
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_revision(int $revision_id, array $related_obj_names = [], array $where_query = [])
+	{
+		// get revision object
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
+			// no related_obj_name so we assume we're saving a revision on this object.
+			if (empty($related_obj_names)) {
+				$fields = $this->get_model()->get_meta_table_fields();
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
+				}
+				$this->save();
+			}
+			foreach ($related_obj_names as $related_name) {
+				// related_obj_name so we're saving a revision on an object related to this object
+				// do we have $where_query params for this related object?  If we do then we include that.
+				$cols_n_values         = $where_query[ $related_name ] ?? [];
+				$where_params          = ! empty($cols_n_values)
+					? [$cols_n_values]
+					: [];
+				$related_objs          = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
+				// load helper
+				// remove related objs from this object that are not in revision
+				// array_diff *should* work cause I think objects are indexed by ID?
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
+				}
+				// add all related objs attached to revision to this object
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
+	 * If only $id is set:
+	 *  it will return all meta values in an associative array.
+	 * If $single is set to false, or left blank:
+	 *  the function returns an array containing all values of the specified key.
+	 * If $single is set to true:
+	 *  the function returns the first value of the specified key (not in an array)
+	 *
+	 * @param string $meta_key
+	 * @param bool   $single
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function get_post_meta(string $meta_key = '', bool $single = false)
+	{
+		return get_post_meta($this->ID(), $meta_key, $single);
+	}
+
+
+	/**
+	 * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
+	 * Returns meta_id if the meta doesn't exist,
+	 * otherwise returns true on success and false on failure.
+	 * NOTE: If the meta_value passed to this function is the same
+	 * as the value that is already in the database, this function returns false.
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $prev_value
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_post_meta(string $meta_key, $meta_value, $prev_value = null)
+	{
+		if (! $this->ID()) {
+			$this->save();
+		}
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
+	}
+
+
+	/**
+	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
+	 *
+	 * @param string $meta_key
+	 * @param mixed $meta_value
+	 * @param bool  $unique     If postmeta for this $meta_key already exists,
+	 *                          whether to add an additional item or not
+	 * @return boolean          Boolean true, except if the $unique argument was set to true
+	 *                          and a custom field with the given key already exists,
+	 *                          in which case false is returned.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_post_meta(string $meta_key, $meta_value, bool $unique = false): bool
+	{
+		if ($this->ID()) {
+			$this->save();
+		}
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
+	}
+
+
+	/**
+	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
+	 *
+	 * @param string $meta_key
+	 * @param mixed $meta_value
+	 * @return boolean False for failure. True for success.
+	 * @throws EE_Error
+	 */
+	public function delete_post_meta(string $meta_key, $meta_value = ''): bool
+	{
+		if (! $this->ID()) {
+			// there is obviously no postmeta for this if it's not saved
+			// so let's just report this as a success
+			return true;
+		}
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink(): string
+	{
+		return get_permalink($this->ID());
+	}
+
+
+	/**
+	 * Gets all the term-taxonomies for this CPT
+	 *
+	 * @param array $query_params
+	 * @return EE_Term_Taxonomy[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function term_taxonomies(array $query_params = []): array
+	{
+		return $this->get_many_related('Term_Taxonomy', $query_params);
+	}
+
+
+	/**
+	 * @return string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_custom_post_statuses(): array
+	{
+		return $this->get_model()->get_custom_post_statuses();
+	}
+
+
+	/**
+	 * @return string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_post_statuses(): array
+	{
+		return $this->get_model()->get_status_array();
+	}
+
+
+	/**
+	 * When fetching a new value for a post field that uses the global $post for rendering,
+	 * set the global $post temporarily to be this model object; and afterwards restore it
+	 *
+	 * @param string      $field_name
+	 * @param bool        $pretty
+	 * @param string|null $extra_cache_ref
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_fresh_property(string $field_name, bool $pretty = false, string $extra_cache_ref = '')
+	{
+		global $post;
+
+		if (
+			$pretty
+			&& (
+				! ($post instanceof WP_Post && $post->ID)
+				|| absint($post->ID) !== $this->ID()
+			)
+			&& $this->get_model()->field_settings_for($field_name) instanceof EE_Post_Content_Field
+		) {
+			$old_post     = $post;
+			$post         = $this->wp_post();
+			$return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
+			$post         = $old_post;
+		} else {
+			$return_value = parent::_get_fresh_property($field_name, $pretty, $extra_cache_ref);
+		}
+		return $return_value;
+	}
+
+
+	/**
+	 * Returns the WP post associated with this CPT model object.
+	 * If this CPT is saved, fetches it from the DB.
+	 * Otherwise, create an unsaved WP_POst object. Caches the post internally.
+	 *
+	 * @return WP_Post
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_post(): WP_Post
+	{
+		global $wpdb;
+		if (! $this->_wp_post instanceof WP_Post) {
+			if ($this->ID()) {
+				$this->_wp_post = get_post($this->ID());
+			} else {
+				$simulated_db_result = new stdClass();
+				$field_settings      = $this->get_model()->field_settings(true);
+				foreach ($field_settings as $field_name => $field_obj) {
+					if (
+						$this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())
+							 ->get_table_name() === $wpdb->posts
+					) {
+						$column = $field_obj->get_table_column();
+
+						if ($field_obj instanceof EE_Datetime_Field) {
+							$value_on_model_obj = $this->get_DateTime_object($field_name);
+						} elseif ($field_obj->is_db_only_field()) {
+							$value_on_model_obj = $field_obj->get_default_value();
+						} else {
+							$value_on_model_obj = $this->get_raw($field_name);
+						}
+						$simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
+					}
+				}
+				$this->_wp_post = new WP_Post($simulated_db_result);
+			}
+			// and let's make retrieving the EE CPT object easy too
+			$classname = get_class($this);
+			if (! isset($this->_wp_post->{$classname})) {
+				$this->_wp_post->{$classname} = $this;
+			}
+		}
+		return $this->_wp_post;
+	}
+
+
+	/**
+	 * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __sleep()
+	{
+		$properties_to_serialize = parent::__sleep();
+		return array_diff($properties_to_serialize, ['_wp_post']);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -79,7 +79,7 @@ 
      */
     public function remove_relation_to_term_taxonomy(EE_Term_Taxonomy $term_taxonomy): ?EE_Base_Class
     {
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -185,11 +185,11 @@ 
             ? implode('_', $attr)
             : $attr;
         $cache_key                          = is_array($size)
-            ? implode('_', $size) . $attr_key
-            : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = $this->_feature_image[ $cache_key ]
+            ? implode('_', $size).$attr_key
+            : $size.$attr_key;
+        $this->_feature_image[$cache_key] = $this->_feature_image[$cache_key]
                                               ?? $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
+        return $this->_feature_image[$cache_key];
     }
 
 
@@ -247,7 +247,7 @@ 
             foreach ($related_obj_names as $related_name) {
                 // related_obj_name so we're saving a revision on an object related to this object
                 // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values         = $where_query[ $related_name ] ?? [];
+                $cols_n_values         = $where_query[$related_name] ?? [];
                 $where_params          = ! empty($cols_n_values)
                     ? [$cols_n_values]
                     : [];
@@ -305,7 +305,7 @@ 
      */
     public function update_post_meta(string $meta_key, $meta_value, $prev_value = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
@@ -344,7 +344,7 @@ 
      */
     public function delete_post_meta(string $meta_key, $meta_value = ''): bool
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             // there is obviously no postmeta for this if it's not saved
             // so let's just report this as a success
             return true;
@@ -447,7 +447,7 @@ 
     public function wp_post(): WP_Post
     {
         global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
+        if ( ! $this->_wp_post instanceof WP_Post) {
             if ($this->ID()) {
                 $this->_wp_post = get_post($this->ID());
             } else {
@@ -474,7 +474,7 @@ 
             }
             // and let's make retrieving the EE CPT object easy too
             $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
+            if ( ! isset($this->_wp_post->{$classname})) {
                 $this->_wp_post->{$classname} = $this;
             }
         }

core/db_classes/EE_Event.class.php

Doc Comments +3 added lines, -3 removed lines

@@ -721,7 +721,7 @@ 
      * Removes a venue from the event
      *
      * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Venue|null
+     * @return EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -881,7 +881,7 @@ 
     /**
      * calculate spaces remaining based on "saleable" tickets
      *
-     * @param array $tickets
+     * @param EE_Ticket[] $tickets
      * @param bool  $filtered
      * @return int|float
      * @throws EE_Error
@@ -1272,7 +1272,7 @@ 
      *
      * @param array $query_params @see
      *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Term|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +1450 added lines, -1450 removed lines

@@ -15,1454 +15,1454 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(
-        array $props_n_values = [],
-        string $timezone = '',
-        array $date_formats = []
-    ): EE_Event {
-        /** @var EE_Event $has_object */
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ?: new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = [], string $timezone = ''): EE_Event
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws EE_Error
-     */
-    public function getAvailableSpacesCalculator(): EventSpacesCalculator
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set(string $field_name, $field_value, bool $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @param string|null $status
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_status(string $status = null, bool $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $status) {
-            // TO sold_out
-            if ($status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes(array $query_params = []): array
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_in_chronological_order(): array
-    {
-        return $this->get_many_related('Datetime', ['order_by' => ['DTT_EVT_start' => 'ASC']]);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param int    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_ordered(bool $show_expired = true, bool $show_deleted = false, int $limit = 0): array
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_datetime(): EE_Datetime
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function primary_datetime(
-        bool $try_to_exclude_expired = true,
-        bool $try_to_exclude_deleted = true
-    ): EE_Datetime {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tickets(array $query_params = []): array
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return [];
-        }
-        $datetime_ids = [];
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = ['Datetime.DTT_ID' => ['IN', $datetime_ids]];
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function active_tickets(): array
-    {
-        return $this->tickets(
-            [
-                [
-                    'TKT_end_date' => ['>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')],
-                    'TKT_deleted'  => false,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit(): bool
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow(): bool
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created(): bool
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description(): bool
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered(): string
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description(): bool
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector(): bool
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url(): bool
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only(): bool
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone(): bool
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified(): bool
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name(): bool
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order(): bool
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param string|null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description(int $num_words = 55, string $more = null, bool $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function slug(): string
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function timezone_string(): string
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function visible_on(): string
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user(): int
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations(): bool
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj): ?EE_Venue
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venues(array $query_params = []): array
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published(): bool
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_upcoming(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_active(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_expired(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining(array $tickets = [], bool $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this event's datetime reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public function perform_sold_out_status_check(): bool
-    {
-        // get all tickets
-        $tickets     = $this->tickets(
-            [
-                'default_where_conditions' => 'none',
-                'order_by'                 => ['TKT_qty' => 'ASC'],
-            ]
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @uses EE_Event::total_available_spaces()
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param bool $consider_sold   Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces(bool $consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param bool $actual  whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_sold_out(bool $actual = false): bool
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function is_postponed(): bool
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function is_cancelled(): bool
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_status(bool $reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = [['EVT_ID' => $this->ID()]];
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (
-                EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::active,
-                    $where_params_for_event
-                ) > 0
-            ) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (
-                    EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::upcoming,
-                        $where_params_for_event
-                    ) > 0
-                ) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (
-                        EEM_Datetime::instance()->get_datetime_count_for_status(
-                            EE_Datetime::expired,
-                            $where_params_for_event
-                        ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return string string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pretty_active_status(bool $echo = true): string
-    {
-        $active_status = $this->get_active_status();
-        $status        = '<span class="ee-status event-active-status-'
-                         . $active_status
-                         . '">'
-                         . EEH_Template::pretty_status($active_status, false, 'sentence')
-                         . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_count_of_all_registrations(): int
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_earliest_start_time(): ?EE_Ticket
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params             = [$where, 'order_by' => ['TKT_start_date' => 'ASC']];
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_latest_end_time(): ?EE_Ticket
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params             = [$where, 'order_by' => ['TKT_end_date' => 'DESC']];
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function countTicketsOnSale(): int
-    {
-        $where = [
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => ['<', time()],
-            'TKT_end_date'    => ['>', time()],
-        ];
-        return EEM_Ticket::instance()->count([$where]);
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tickets_on_sale(): bool
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink(): string
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Term|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_event_category(array $query_params = []): ?EE_Term
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Term[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_categories(array $query_params = []): array
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
-    {
-        // If the row already exists, it will be updated. If it doesn't, it will be inserted.
-        // That's in EE_HABTM_Relation::add_relation_to().
-        return $this->_add_relation_to(
-            $question_group_id_or_obj,
-            'Question_Group',
-            [
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true,
-            ]
-        );
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
-    {
-        // If the question group is used for the other type (primary or additional)
-        // then just update it. If not, delete it outright.
-        $existing_relation = $this->get_first_related(
-            'Event_Question_Group',
-            [
-                [
-                    'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj),
-                ],
-            ]
-        );
-        $field_to_update   = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
-        if ($existing_relation->get($other_field) === false) {
-            // Delete it. It's now no longer for primary or additional question groups.
-            return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
-        }
-        // Just update it. They'll still use this question group for the other category
-        $existing_relation->save(
-            [
-                $field_to_update => false,
-            ]
-        );
-        return $question_group_id_or_obj;
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question_groups(array $query_params = []): array
-    {
-        $query_params = ! empty($query_params)
-            ? $query_params
-            : ['order_by' => ['QSG_order' => 'ASC']];
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @return string
-     * @see EEI_Visual_Representation for comments
-     */
-    public function get_icon(): string
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @throws EE_Error
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_details_link(): string
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @throws EE_Error
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_edit_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_settings_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_overview_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ],
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(
+		array $props_n_values = [],
+		string $timezone = '',
+		array $date_formats = []
+	): EE_Event {
+		/** @var EE_Event $has_object */
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			?: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = [], string $timezone = ''): EE_Event
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws EE_Error
+	 */
+	public function getAvailableSpacesCalculator(): EventSpacesCalculator
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set(string $field_name, $field_value, bool $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @param string|null $status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_status(string $status = null, bool $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $status) {
+			// TO sold_out
+			if ($status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes(array $query_params = []): array
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_in_chronological_order(): array
+	{
+		return $this->get_many_related('Datetime', ['order_by' => ['DTT_EVT_start' => 'ASC']]);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param int    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_ordered(bool $show_expired = true, bool $show_deleted = false, int $limit = 0): array
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_datetime(): EE_Datetime
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function primary_datetime(
+		bool $try_to_exclude_expired = true,
+		bool $try_to_exclude_deleted = true
+	): EE_Datetime {
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tickets(array $query_params = []): array
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return [];
+		}
+		$datetime_ids = [];
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = ['Datetime.DTT_ID' => ['IN', $datetime_ids]];
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function active_tickets(): array
+	{
+		return $this->tickets(
+			[
+				[
+					'TKT_end_date' => ['>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')],
+					'TKT_deleted'  => false,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit(): bool
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow(): bool
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created(): bool
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description(): bool
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered(): string
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description(): bool
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector(): bool
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url(): bool
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only(): bool
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone(): bool
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified(): bool
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name(): bool
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order(): bool
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param string|null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description(int $num_words = 55, string $more = null, bool $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function slug(): string
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timezone_string(): string
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function visible_on(): string
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations(): bool
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj): ?EE_Venue
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venues(array $query_params = []): array
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published(): bool
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_upcoming(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_active(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_expired(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining(array $tickets = [], bool $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this event's datetime reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public function perform_sold_out_status_check(): bool
+	{
+		// get all tickets
+		$tickets     = $this->tickets(
+			[
+				'default_where_conditions' => 'none',
+				'order_by'                 => ['TKT_qty' => 'ASC'],
+			]
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @uses EE_Event::total_available_spaces()
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param bool $consider_sold   Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces(bool $consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param bool $actual  whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_sold_out(bool $actual = false): bool
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function is_postponed(): bool
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function is_cancelled(): bool
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_status(bool $reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = [['EVT_ID' => $this->ID()]];
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (
+				EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::active,
+					$where_params_for_event
+				) > 0
+			) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (
+					EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::upcoming,
+						$where_params_for_event
+					) > 0
+				) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (
+						EEM_Datetime::instance()->get_datetime_count_for_status(
+							EE_Datetime::expired,
+							$where_params_for_event
+						) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return string string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pretty_active_status(bool $echo = true): string
+	{
+		$active_status = $this->get_active_status();
+		$status        = '<span class="ee-status event-active-status-'
+						 . $active_status
+						 . '">'
+						 . EEH_Template::pretty_status($active_status, false, 'sentence')
+						 . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_count_of_all_registrations(): int
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_earliest_start_time(): ?EE_Ticket
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params             = [$where, 'order_by' => ['TKT_start_date' => 'ASC']];
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_latest_end_time(): ?EE_Ticket
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params             = [$where, 'order_by' => ['TKT_end_date' => 'DESC']];
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function countTicketsOnSale(): int
+	{
+		$where = [
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => ['<', time()],
+			'TKT_end_date'    => ['>', time()],
+		];
+		return EEM_Ticket::instance()->count([$where]);
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tickets_on_sale(): bool
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink(): string
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Term|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_event_category(array $query_params = []): ?EE_Term
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Term[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_categories(array $query_params = []): array
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
+	{
+		// If the row already exists, it will be updated. If it doesn't, it will be inserted.
+		// That's in EE_HABTM_Relation::add_relation_to().
+		return $this->_add_relation_to(
+			$question_group_id_or_obj,
+			'Question_Group',
+			[
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true,
+			]
+		);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
+	{
+		// If the question group is used for the other type (primary or additional)
+		// then just update it. If not, delete it outright.
+		$existing_relation = $this->get_first_related(
+			'Event_Question_Group',
+			[
+				[
+					'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj),
+				],
+			]
+		);
+		$field_to_update   = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
+		$other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+		if ($existing_relation->get($other_field) === false) {
+			// Delete it. It's now no longer for primary or additional question groups.
+			return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
+		}
+		// Just update it. They'll still use this question group for the other category
+		$existing_relation->save(
+			[
+				$field_to_update => false,
+			]
+		);
+		return $question_group_id_or_obj;
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question_groups(array $query_params = []): array
+	{
+		$query_params = ! empty($query_params)
+			? $query_params
+			: ['order_by' => ['QSG_order' => 'ASC']];
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @return string
+	 * @see EEI_Visual_Representation for comments
+	 */
+	public function get_icon(): string
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_details_link(): string
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_edit_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_settings_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_overview_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			],
+			admin_url('admin.php')
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -78,7 +78,7 @@ 
      */
     public function getAvailableSpacesCalculator(): EventSpacesCalculator
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -228,7 +228,7 @@ 
         bool $try_to_exclude_expired = true,
         bool $try_to_exclude_deleted = true
     ): EE_Datetime {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -253,7 +253,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return [];
         }
         $datetime_ids = [];
@@ -447,7 +447,7 @@ 
     public function short_description(int $num_words = 55, string $more = null, bool $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -917,7 +917,7 @@ 
     public function perform_sold_out_status_check(): bool
     {
         // get all tickets
-        $tickets     = $this->tickets(
+        $tickets = $this->tickets(
             [
                 'default_where_conditions' => 'none',
                 'order_by'                 => ['TKT_qty' => 'ASC'],
@@ -925,7 +925,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -1017,7 +1017,7 @@ 
      */
     public function is_sold_out(bool $actual = false): bool
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1067,11 +1067,11 @@ 
     public function get_active_status(bool $reset = false)
     {
         // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = [['EVT_ID' => $this->ID()]];
@@ -1162,7 +1162,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();
@@ -1353,7 +1353,7 @@ 
             ]
         );
         $field_to_update   = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+        $other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext( ! $for_primary);
         if ($existing_relation->get($other_field) === false) {
             // Delete it. It's now no longer for primary or additional question groups.
             return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');

core/db_models/EEM_Answer.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -94,7 +94,7 @@ 
      * on the attendee or in the answer table. This function finds its value regardless)
      *
      * @param EE_Registration $registration
-     * @param int|string      $question_id
+     * @param integer      $question_id
      * @param bool            $pretty_answer whether to call 'pretty_value' or just 'value'
      * @return string
      * @throws EE_Error
@@ -125,7 +125,7 @@ 
      * Gets the EE_Answer object for the question for this registration (if it exists)
      *
      * @param EE_Registration $registration
-     * @param int|null        $question_id
+     * @param integer        $question_id
      * @return EE_Answer
      * @throws EE_Error
      * @throws ReflectionException
@@ -146,7 +146,7 @@ 
      * Gets the string answer to the question for this registration's attendee
      *
      * @param EE_Registration $registration
-     * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
+     * @param integer      $question_system_id if an INT this is understood to be the question's ID; if a string
      *                                            then it should be its QST_system value. Passing in the QST_system
      *                                            value is more efficient
      * @param boolean         $pretty_answer

Indentation +200 added lines, -200 removed lines

@@ -10,213 +10,213 @@
 class EEM_Answer extends EEM_Base
 {
 
-    /**
-     * private instance of the EEM_Answer object
-     *
-     * @var EEM_Answer
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_Answer object
+	 *
+	 * @var EEM_Answer
+	 */
+	protected static $_instance;
 
-    /**
-     * Mapping from system question ids to attendee field names
-     *
-     * @var array
-     * @deprecated since version 4.8.8
-     */
-    protected $_question_id_to_att_field_map
-        = [
-            EEM_Attendee::fname_question_id    => 'ATT_fname',
-            EEM_Attendee::lname_question_id    => 'ATT_lname',
-            EEM_Attendee::email_question_id    => 'ATT_email',
-            EEM_Attendee::address_question_id  => 'ATT_address',
-            EEM_Attendee::address2_question_id => 'ATT_address2',
-            EEM_Attendee::city_question_id     => 'ATT_city',
-            EEM_Attendee::state_question_id    => 'STA_ID',
-            EEM_Attendee::country_question_id  => 'CNT_ISO',
-            EEM_Attendee::zip_question_id      => 'ATT_zip',
-            EEM_Attendee::phone_question_id    => 'ATT_phone',
-        ];
+	/**
+	 * Mapping from system question ids to attendee field names
+	 *
+	 * @var array
+	 * @deprecated since version 4.8.8
+	 */
+	protected $_question_id_to_att_field_map
+		= [
+			EEM_Attendee::fname_question_id    => 'ATT_fname',
+			EEM_Attendee::lname_question_id    => 'ATT_lname',
+			EEM_Attendee::email_question_id    => 'ATT_email',
+			EEM_Attendee::address_question_id  => 'ATT_address',
+			EEM_Attendee::address2_question_id => 'ATT_address2',
+			EEM_Attendee::city_question_id     => 'ATT_city',
+			EEM_Attendee::state_question_id    => 'STA_ID',
+			EEM_Attendee::country_question_id  => 'CNT_ISO',
+			EEM_Attendee::zip_question_id      => 'ATT_zip',
+			EEM_Attendee::phone_question_id    => 'ATT_phone',
+		];
 
 
-    /**
-     *  constructor
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item           = esc_html__('Answer', 'event_espresso');
-        $this->plural_item             = esc_html__('Answers', 'event_espresso');
-        $this->_tables                 = [
-            'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID'),
-        ];
-        $this->_fields                 = [
-            'Answer' => [
-                'ANS_ID'    => new EE_Primary_Key_Int_Field(
-                    'ANS_ID',
-                    esc_html__('Answer ID', 'event_espresso')
-                ),
-                'REG_ID'    => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'QST_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field(
-                    'ANS_value',
-                    esc_html__('Answer Value', 'event_espresso'),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Question'     => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        $this->_caps_slug              = 'registrations';
-        parent::__construct($timezone);
-    }
+	/**
+	 *  constructor
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item           = esc_html__('Answer', 'event_espresso');
+		$this->plural_item             = esc_html__('Answers', 'event_espresso');
+		$this->_tables                 = [
+			'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID'),
+		];
+		$this->_fields                 = [
+			'Answer' => [
+				'ANS_ID'    => new EE_Primary_Key_Int_Field(
+					'ANS_ID',
+					esc_html__('Answer ID', 'event_espresso')
+				),
+				'REG_ID'    => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'QST_ID'    => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field(
+					'ANS_value',
+					esc_html__('Answer Value', 'event_espresso'),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Question'     => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		$this->_caps_slug              = 'registrations';
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Gets the string answer to the question for this registration (it could either be stored
-     * on the attendee or in the answer table. This function finds its value regardless)
-     *
-     * @param EE_Registration $registration
-     * @param int|string      $question_id
-     * @param bool            $pretty_answer whether to call 'pretty_value' or just 'value'
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_answer_value_to_question(
-        EE_Registration $registration,
-        $question_id = 0,
-        bool $pretty_answer = false
-    ): string {
-        $value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
-        if ($value === null) {
-            $answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
-            if ($answer_obj instanceof EE_Answer) {
-                $value = $pretty_answer ? $answer_obj->pretty_value() : $answer_obj->value();
-            }
-        }
-        return apply_filters(
-            'FHEE__EEM_Answer__get_answer_value_to_question__answer_value',
-            $value,
-            $registration,
-            $question_id
-        );
-    }
+	/**
+	 * Gets the string answer to the question for this registration (it could either be stored
+	 * on the attendee or in the answer table. This function finds its value regardless)
+	 *
+	 * @param EE_Registration $registration
+	 * @param int|string      $question_id
+	 * @param bool            $pretty_answer whether to call 'pretty_value' or just 'value'
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_answer_value_to_question(
+		EE_Registration $registration,
+		$question_id = 0,
+		bool $pretty_answer = false
+	): string {
+		$value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
+		if ($value === null) {
+			$answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
+			if ($answer_obj instanceof EE_Answer) {
+				$value = $pretty_answer ? $answer_obj->pretty_value() : $answer_obj->value();
+			}
+		}
+		return apply_filters(
+			'FHEE__EEM_Answer__get_answer_value_to_question__answer_value',
+			$value,
+			$registration,
+			$question_id
+		);
+	}
 
 
-    /**
-     * Gets the EE_Answer object for the question for this registration (if it exists)
-     *
-     * @param EE_Registration $registration
-     * @param int|null        $question_id
-     * @return EE_Answer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_registration_question_answer_object(EE_Registration $registration, int $question_id = 0):
-    EE_Answer {
-        $answer_obj = $this->get_one([['QST_ID' => $question_id, 'REG_ID' => $registration->ID()]]);
-        return apply_filters(
-            'FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj',
-            $answer_obj,
-            $registration,
-            $question_id
-        );
-    }
+	/**
+	 * Gets the EE_Answer object for the question for this registration (if it exists)
+	 *
+	 * @param EE_Registration $registration
+	 * @param int|null        $question_id
+	 * @return EE_Answer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_registration_question_answer_object(EE_Registration $registration, int $question_id = 0):
+	EE_Answer {
+		$answer_obj = $this->get_one([['QST_ID' => $question_id, 'REG_ID' => $registration->ID()]]);
+		return apply_filters(
+			'FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj',
+			$answer_obj,
+			$registration,
+			$question_id
+		);
+	}
 
 
-    /**
-     * Gets the string answer to the question for this registration's attendee
-     *
-     * @param EE_Registration $registration
-     * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
-     *                                            then it should be its QST_system value. Passing in the QST_system
-     *                                            value is more efficient
-     * @param boolean         $pretty_answer
-     * @return string|null                        if the registration has no attendee, or the question_system_id is
-     *                                            not a QST_ID or QST_system for a question corresponding to an
-     *                                            attendee field, returns null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_attendee_property_answer_value(
-        EE_Registration $registration,
-        $question_system_id = 0,
-        bool $pretty_answer = false
-    ): ?string {
-        $value = null;
-        // backward compat: we still want to find the question's ID
-        if (is_numeric($question_system_id)) {
-            // find this question's QST_system value
-            $question_id        = $question_system_id;
-            $question_system_id = EEM_Question::instance()->get_var(
-                [['QST_ID' => $question_system_id]],
-                'QST_system'
-            );
-        } else {
-            $question_id = (int) EEM_Question::instance()->get_var(
-                [['QST_system' => $question_system_id]],
-                'QST_ID'
-            );
-        }
-        // only bother checking if the registration has an attendee
-        if ($registration->attendee() instanceof EE_Attendee) {
-            $field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
-            if ($field_name) {
-                if ($pretty_answer) {
-                    switch($field_name ) {
-                        case 'STA_ID':
-                            $state = $registration->attendee()->state_obj();
-                            $value
-                                   = $state instanceof EE_State
-                                ? $state->name()
-                                : sprintf(
-                                    esc_html__('Unknown State (%s)', 'event_espresso'),
-                                    $registration->attendee()->state_ID()
-                                );
-                            break;
-                        case 'CNT_ISO':
-                            $country = $registration->attendee()->country_obj();
-                            $value   = $country instanceof EE_Country
-                                ? $country->name()
-                                : sprintf(
-                                    esc_html__('Unknown Country (%s)', 'event_espresso'),
-                                    $registration->attendee()->country_ID()
-                                );
-                            break;
-                        default:
-                            $value = $registration->attendee()->get_pretty($field_name);
-                    }
-                    // if field name is blank, leave the value as null too
-                } else {
-                    $value = $registration->attendee()->get($field_name);
-                }
-            }
-            // if no field was found, leave value blank
-        }
-        return apply_filters(
-            'FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value',
-            $value,
-            $registration,
-            $question_id,
-            $question_system_id
-        );
-    }
+	/**
+	 * Gets the string answer to the question for this registration's attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
+	 *                                            then it should be its QST_system value. Passing in the QST_system
+	 *                                            value is more efficient
+	 * @param boolean         $pretty_answer
+	 * @return string|null                        if the registration has no attendee, or the question_system_id is
+	 *                                            not a QST_ID or QST_system for a question corresponding to an
+	 *                                            attendee field, returns null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_attendee_property_answer_value(
+		EE_Registration $registration,
+		$question_system_id = 0,
+		bool $pretty_answer = false
+	): ?string {
+		$value = null;
+		// backward compat: we still want to find the question's ID
+		if (is_numeric($question_system_id)) {
+			// find this question's QST_system value
+			$question_id        = $question_system_id;
+			$question_system_id = EEM_Question::instance()->get_var(
+				[['QST_ID' => $question_system_id]],
+				'QST_system'
+			);
+		} else {
+			$question_id = (int) EEM_Question::instance()->get_var(
+				[['QST_system' => $question_system_id]],
+				'QST_ID'
+			);
+		}
+		// only bother checking if the registration has an attendee
+		if ($registration->attendee() instanceof EE_Attendee) {
+			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
+			if ($field_name) {
+				if ($pretty_answer) {
+					switch($field_name ) {
+						case 'STA_ID':
+							$state = $registration->attendee()->state_obj();
+							$value
+								   = $state instanceof EE_State
+								? $state->name()
+								: sprintf(
+									esc_html__('Unknown State (%s)', 'event_espresso'),
+									$registration->attendee()->state_ID()
+								);
+							break;
+						case 'CNT_ISO':
+							$country = $registration->attendee()->country_obj();
+							$value   = $country instanceof EE_Country
+								? $country->name()
+								: sprintf(
+									esc_html__('Unknown Country (%s)', 'event_espresso'),
+									$registration->attendee()->country_ID()
+								);
+							break;
+						default:
+							$value = $registration->attendee()->get_pretty($field_name);
+					}
+					// if field name is blank, leave the value as null too
+				} else {
+					$value = $registration->attendee()->get($field_name);
+				}
+			}
+			// if no field was found, leave value blank
+		}
+		return apply_filters(
+			'FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value',
+			$value,
+			$registration,
+			$question_id,
+			$question_system_id
+		);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration' => new EE_Belongs_To_Relation(),
             'Question'     => new EE_Belongs_To_Relation(),
         ];
@@ -181,7 +181,7 @@ 
             $field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
             if ($field_name) {
                 if ($pretty_answer) {
-                    switch($field_name ) {
+                    switch ($field_name) {
                         case 'STA_ID':
                             $state = $registration->attendee()->state_obj();
                             $value

core/db_models/EEM_Attendee.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -323,7 +323,7 @@ 
      * Gets all the attendees for a transaction (by using the esp_registration as a join table)
      *
      * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|null
+     * @return EE_Base_Class[]
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -345,7 +345,7 @@ 
      * retrieve  a single attendee from db via their ID
      *
      * @param int $ATT_ID
-     * @return EE_Attendee[]|null array on success, FALSE on fail
+     * @return EE_Base_Class|null array on success, FALSE on fail
      * @throws EE_Error
      * @throws ReflectionException
      * @deprecated
@@ -361,7 +361,7 @@ 
      * retrieve  a single attendee from db via their ID
      *
      * @param array $where_cols_n_values
-     * @return EE_Attendee|null entity on success, null on fail
+     * @return null|EE_Base_Class entity on success, null on fail
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +413 added lines, -413 removed lines

@@ -12,425 +12,425 @@
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance;
+	// private instance of the Attendee object
+	protected static $_instance;
 
-    /**
-     * QST_system for questions are strings not integers now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not integers now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
-
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname         = 'fname';
-
-    const system_question_lname         = 'lname';
-
-    const system_question_email         = 'email';
-
-    const system_question_email_confirm = 'email_confirm';
-
-    const system_question_address       = 'address';
-
-    const system_question_address2      = 'address2';
-
-    const system_question_city          = 'city';
-
-    const system_question_state         = 'state';
-
-    const system_question_country       = 'country';
-
-    const system_question_zip           = 'zip';
-
-    const system_question_phone         = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name
-        = [
-            EEM_Attendee::system_question_fname    => 'ATT_fname',
-            EEM_Attendee::system_question_lname    => 'ATT_lname',
-            EEM_Attendee::system_question_email    => 'ATT_email',
-            EEM_Attendee::system_question_address  => 'ATT_address',
-            EEM_Attendee::system_question_address2 => 'ATT_address2',
-            EEM_Attendee::system_question_city     => 'ATT_city',
-            EEM_Attendee::system_question_state    => 'STA_ID',
-            EEM_Attendee::system_question_country  => 'CNT_ISO',
-            EEM_Attendee::system_question_zip      => 'ATT_zip',
-            EEM_Attendee::system_question_phone    => 'ATT_phone',
-        ];
-
-
-    /**
-     * EEM_Attendee constructor.
-     *
-     * @param string                 $timezone
-     * @param ModelFieldFactory|null $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(string $timezone = '', ModelFieldFactory $model_field_factory = null)
-    {
-        $this->singular_item           = esc_html__('Attendee', 'event_espresso');
-        $this->plural_item             = esc_html__('Attendees', 'event_espresso');
-        $this->_tables                 = [
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table(
-                'esp_attendee_meta',
-                'ATTM_ID',
-                'ATT_ID'
-            ),
-        ];
-        $this->_fields                 = [
-            'Attendee_CPT'  => [
-                'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('Attendee ID', 'event_espresso')
-                ),
-                'ATT_full_name' => $model_field_factory->createPlainTextField(
-                    'post_title',
-                    esc_html__('Attendee Full Name', 'event_espresso'),
-                    false,
-                    esc_html__('Unknown', 'event_espresso')
-                ),
-                'ATT_bio'       => $model_field_factory->createPostContentField(
-                    'post_content',
-                    esc_html__('Attendee Biography', 'event_espresso'),
-                    false,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_slug'      => $model_field_factory->createSlugField(
-                    'post_name',
-                    esc_html__('Attendee URL Slug', 'event_espresso')
-                ),
-                'ATT_created'   => $model_field_factory->createDatetimeField(
-                    'post_date',
-                    esc_html__('Time Attendee Created', 'event_espresso')
-                ),
-                'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
-                    'post_excerpt',
-                    esc_html__('Attendee Short Biography', 'event_espresso'),
-                    true,
-                    esc_html__('No Biography Provided', 'event_espresso')
-                ),
-                'ATT_modified'  => $model_field_factory->createDatetimeField(
-                    'post_modified',
-                    esc_html__('Time Attendee Last Modified', 'event_espresso')
-                ),
-                'ATT_author'    => $model_field_factory->createWpUserField(
-                    'post_author',
-                    esc_html__('Creator ID of the first Event attended', 'event_espresso'),
-                    false
-                ),
-                'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
-                    'post_parent',
-                    esc_html__('Parent Attendee (unused)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
-                'status'        => $model_field_factory->createWpPostStatusField(
-                    'post_status',
-                    esc_html__('Attendee Status', 'event_espresso'),
-                    false,
-                    'publish'
-                ),
-                'password'      => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    [
-                        'ATT_bio',
-                        'ATT_short_bio',
-                        'ATT_address',
-                        'ATT_address2',
-                        'ATT_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'ATT_zip',
-                        'ATT_email',
-                        'ATT_phone',
-                    ]
-                ),
-            ],
-            'Attendee_Meta' => [
-                'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
-                    'ATTM_ID',
-                    esc_html__('Attendee Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
-                    'ATT_ID',
-                    esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
-                    false
-                ),
-                'ATT_fname'    => $model_field_factory->createPlainTextField(
-                    'ATT_fname',
-                    esc_html__('First Name', 'event_espresso')
-                ),
-                'ATT_lname'    => $model_field_factory->createPlainTextField(
-                    'ATT_lname',
-                    esc_html__('Last Name', 'event_espresso')
-                ),
-                'ATT_address'  => $model_field_factory->createPlainTextField(
-                    'ATT_address',
-                    esc_html__('Address Part 1', 'event_espresso')
-                ),
-                'ATT_address2' => $model_field_factory->createPlainTextField(
-                    'ATT_address2',
-                    esc_html__('Address Part 2', 'event_espresso')
-                ),
-                'ATT_city'     => $model_field_factory->createPlainTextField(
-                    'ATT_city',
-                    esc_html__('City', 'event_espresso')
-                ),
-                'STA_ID'       => $model_field_factory->createForeignKeyIntField(
-                    'STA_ID',
-                    esc_html__('State', 'event_espresso'),
-                    true,
-                    0,
-                    'State'
-                ),
-                'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
-                    'CNT_ISO',
-                    esc_html__('Country', 'event_espresso'),
-                    true,
-                    '',
-                    'Country'
-                ),
-                'ATT_zip'      => $model_field_factory->createPlainTextField(
-                    'ATT_zip',
-                    esc_html__('ZIP/Postal Code', 'event_espresso')
-                ),
-                'ATT_email'    => $model_field_factory->createEmailField(
-                    'ATT_email',
-                    esc_html__('Email Address', 'event_espresso')
-                ),
-                'ATT_phone'    => $model_field_factory->createPlainTextField(
-                    'ATT_phone',
-                    esc_html__('Phone', 'event_espresso')
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            // allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        ];
-        $this->_caps_slug              = 'contacts';
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question(string $system_question_string): ?string
-    {
-        return $this->_system_question_to_attendee_field_name[ $system_question_string ] ?? null;
-    }
-
-
-    /**
-     * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
-     *
-     * @return array
-     */
-    public function system_question_to_attendee_field_mapping(): array
-    {
-        return $this->_system_question_to_attendee_field_name;
-    }
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj): ?array
-    {
-        return $this->get_all(
-            [
-                [
-                    'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                        ? $transaction_id_or_obj->ID()
-                        : $transaction_id_or_obj,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param int $ATT_ID
-     * @return EE_Attendee[]|null array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public function get_attendee_by_ID(int $ATT_ID = 0): ?EE_Attendee
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-    /**
-     * retrieve  a single attendee from db via their ID
-     *
-     * @param array $where_cols_n_values
-     * @return EE_Attendee|null entity on success, null on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_attendee(array $where_cols_n_values = []): ?EE_Attendee
-    {
-        if (empty($where_cols_n_values)) {
-            return null;
-        }
-        $attendee = $this->get_all([$where_cols_n_values]);
-        if (! empty($attendee)) {
-            return array_shift($attendee);
-        }
-        return null;
-    }
-
-
-    /**
-     * Search for an existing Attendee record in the DB
-     *
-     * @param array $where_cols_n_values
-     * @return EE_Attendee|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function find_existing_attendee(array $where_cols_n_values = []): ?EE_Attendee
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = [
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        ];
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
-            ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data          = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname'])
-                      && ! empty($where_cols_n_values['ATT_fname'])
-                      && $valid_data;
-        $valid_data = isset($where_cols_n_values['ATT_lname'])
-                      && ! empty($where_cols_n_values['ATT_lname'])
-                      && $valid_data;
-        $valid_data = isset($where_cols_n_values['ATT_email'])
-                      && ! empty($where_cols_n_values['ATT_email'])
-                      && $valid_data;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids
-     * and sends back a list of corresponding non duplicate EE_Attendee objects.
-     *
-     * @param array $ids array of EE_Registration ids
-     * @return EE_Attendee[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.3.0
-     */
-    public function get_array_of_contacts_from_reg_ids(array $ids): array
-    {
-        return $this->get_all([['Registration.REG_ID' => ['in', $ids]]]);
-    }
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
+
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname         = 'fname';
+
+	const system_question_lname         = 'lname';
+
+	const system_question_email         = 'email';
+
+	const system_question_email_confirm = 'email_confirm';
+
+	const system_question_address       = 'address';
+
+	const system_question_address2      = 'address2';
+
+	const system_question_city          = 'city';
+
+	const system_question_state         = 'state';
+
+	const system_question_country       = 'country';
+
+	const system_question_zip           = 'zip';
+
+	const system_question_phone         = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name
+		= [
+			EEM_Attendee::system_question_fname    => 'ATT_fname',
+			EEM_Attendee::system_question_lname    => 'ATT_lname',
+			EEM_Attendee::system_question_email    => 'ATT_email',
+			EEM_Attendee::system_question_address  => 'ATT_address',
+			EEM_Attendee::system_question_address2 => 'ATT_address2',
+			EEM_Attendee::system_question_city     => 'ATT_city',
+			EEM_Attendee::system_question_state    => 'STA_ID',
+			EEM_Attendee::system_question_country  => 'CNT_ISO',
+			EEM_Attendee::system_question_zip      => 'ATT_zip',
+			EEM_Attendee::system_question_phone    => 'ATT_phone',
+		];
+
+
+	/**
+	 * EEM_Attendee constructor.
+	 *
+	 * @param string                 $timezone
+	 * @param ModelFieldFactory|null $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(string $timezone = '', ModelFieldFactory $model_field_factory = null)
+	{
+		$this->singular_item           = esc_html__('Attendee', 'event_espresso');
+		$this->plural_item             = esc_html__('Attendees', 'event_espresso');
+		$this->_tables                 = [
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table(
+				'esp_attendee_meta',
+				'ATTM_ID',
+				'ATT_ID'
+			),
+		];
+		$this->_fields                 = [
+			'Attendee_CPT'  => [
+				'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('Attendee ID', 'event_espresso')
+				),
+				'ATT_full_name' => $model_field_factory->createPlainTextField(
+					'post_title',
+					esc_html__('Attendee Full Name', 'event_espresso'),
+					false,
+					esc_html__('Unknown', 'event_espresso')
+				),
+				'ATT_bio'       => $model_field_factory->createPostContentField(
+					'post_content',
+					esc_html__('Attendee Biography', 'event_espresso'),
+					false,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_slug'      => $model_field_factory->createSlugField(
+					'post_name',
+					esc_html__('Attendee URL Slug', 'event_espresso')
+				),
+				'ATT_created'   => $model_field_factory->createDatetimeField(
+					'post_date',
+					esc_html__('Time Attendee Created', 'event_espresso')
+				),
+				'ATT_short_bio' => $model_field_factory->createSimpleHtmlField(
+					'post_excerpt',
+					esc_html__('Attendee Short Biography', 'event_espresso'),
+					true,
+					esc_html__('No Biography Provided', 'event_espresso')
+				),
+				'ATT_modified'  => $model_field_factory->createDatetimeField(
+					'post_modified',
+					esc_html__('Time Attendee Last Modified', 'event_espresso')
+				),
+				'ATT_author'    => $model_field_factory->createWpUserField(
+					'post_author',
+					esc_html__('Creator ID of the first Event attended', 'event_espresso'),
+					false
+				),
+				'ATT_parent'    => $model_field_factory->createDbOnlyIntField(
+					'post_parent',
+					esc_html__('Parent Attendee (unused)', 'event_espresso'),
+					false,
+					0
+				),
+				'post_type'     => $model_field_factory->createWpPostTypeField('espresso_attendees'),
+				'status'        => $model_field_factory->createWpPostStatusField(
+					'post_status',
+					esc_html__('Attendee Status', 'event_espresso'),
+					false,
+					'publish'
+				),
+				'password'      => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					[
+						'ATT_bio',
+						'ATT_short_bio',
+						'ATT_address',
+						'ATT_address2',
+						'ATT_city',
+						'STA_ID',
+						'CNT_ISO',
+						'ATT_zip',
+						'ATT_email',
+						'ATT_phone',
+					]
+				),
+			],
+			'Attendee_Meta' => [
+				'ATTM_ID'      => $model_field_factory->createDbOnlyIntField(
+					'ATTM_ID',
+					esc_html__('Attendee Meta Row ID', 'event_espresso'),
+					false
+				),
+				'ATT_ID_fk'    => $model_field_factory->createDbOnlyIntField(
+					'ATT_ID',
+					esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'),
+					false
+				),
+				'ATT_fname'    => $model_field_factory->createPlainTextField(
+					'ATT_fname',
+					esc_html__('First Name', 'event_espresso')
+				),
+				'ATT_lname'    => $model_field_factory->createPlainTextField(
+					'ATT_lname',
+					esc_html__('Last Name', 'event_espresso')
+				),
+				'ATT_address'  => $model_field_factory->createPlainTextField(
+					'ATT_address',
+					esc_html__('Address Part 1', 'event_espresso')
+				),
+				'ATT_address2' => $model_field_factory->createPlainTextField(
+					'ATT_address2',
+					esc_html__('Address Part 2', 'event_espresso')
+				),
+				'ATT_city'     => $model_field_factory->createPlainTextField(
+					'ATT_city',
+					esc_html__('City', 'event_espresso')
+				),
+				'STA_ID'       => $model_field_factory->createForeignKeyIntField(
+					'STA_ID',
+					esc_html__('State', 'event_espresso'),
+					true,
+					0,
+					'State'
+				),
+				'CNT_ISO'      => $model_field_factory->createForeignKeyStringField(
+					'CNT_ISO',
+					esc_html__('Country', 'event_espresso'),
+					true,
+					'',
+					'Country'
+				),
+				'ATT_zip'      => $model_field_factory->createPlainTextField(
+					'ATT_zip',
+					esc_html__('ZIP/Postal Code', 'event_espresso')
+				),
+				'ATT_email'    => $model_field_factory->createEmailField(
+					'ATT_email',
+					esc_html__('Email Address', 'event_espresso')
+				),
+				'ATT_phone'    => $model_field_factory->createPlainTextField(
+					'ATT_phone',
+					esc_html__('Phone', 'event_espresso')
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			// allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		];
+		$this->_caps_slug              = 'contacts';
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question(string $system_question_string): ?string
+	{
+		return $this->_system_question_to_attendee_field_name[ $system_question_string ] ?? null;
+	}
+
+
+	/**
+	 * Gets mapping from esp_question.QST_system values to their corresponding attendee field names
+	 *
+	 * @return array
+	 */
+	public function system_question_to_attendee_field_mapping(): array
+	{
+		return $this->_system_question_to_attendee_field_name;
+	}
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj): ?array
+	{
+		return $this->get_all(
+			[
+				[
+					'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+						? $transaction_id_or_obj->ID()
+						: $transaction_id_or_obj,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param int $ATT_ID
+	 * @return EE_Attendee[]|null array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID(int $ATT_ID = 0): ?EE_Attendee
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+	/**
+	 * retrieve  a single attendee from db via their ID
+	 *
+	 * @param array $where_cols_n_values
+	 * @return EE_Attendee|null entity on success, null on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_attendee(array $where_cols_n_values = []): ?EE_Attendee
+	{
+		if (empty($where_cols_n_values)) {
+			return null;
+		}
+		$attendee = $this->get_all([$where_cols_n_values]);
+		if (! empty($attendee)) {
+			return array_shift($attendee);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Search for an existing Attendee record in the DB
+	 *
+	 * @param array $where_cols_n_values
+	 * @return EE_Attendee|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function find_existing_attendee(array $where_cols_n_values = []): ?EE_Attendee
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = [
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		];
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values)
+			? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data          = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname'])
+					  && ! empty($where_cols_n_values['ATT_fname'])
+					  && $valid_data;
+		$valid_data = isset($where_cols_n_values['ATT_lname'])
+					  && ! empty($where_cols_n_values['ATT_lname'])
+					  && $valid_data;
+		$valid_data = isset($where_cols_n_values['ATT_email'])
+					  && ! empty($where_cols_n_values['ATT_email'])
+					  && $valid_data;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids
+	 * and sends back a list of corresponding non duplicate EE_Attendee objects.
+	 *
+	 * @param array $ids array of EE_Registration ids
+	 * @return EE_Attendee[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.3.0
+	 */
+	public function get_array_of_contacts_from_reg_ids(array $ids): array
+	{
+		return $this->get_all([['Registration.REG_ID' => ['in', $ids]]]);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -146,7 +146,7 @@ 
                 'ATT_ID'
             ),
         ];
-        $this->_fields                 = [
+        $this->_fields = [
             'Attendee_CPT'  => [
                 'ATT_ID'        => $model_field_factory->createPrimaryKeyIntField(
                     'ID',
@@ -278,7 +278,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration'      => new EE_Has_Many_Relation(),
             'State'             => new EE_Belongs_To_Relation(),
             'Country'           => new EE_Belongs_To_Relation(),
@@ -304,7 +304,7 @@ 
      */
     public function get_attendee_field_for_system_question(string $system_question_string): ?string
     {
-        return $this->_system_question_to_attendee_field_name[ $system_question_string ] ?? null;
+        return $this->_system_question_to_attendee_field_name[$system_question_string] ?? null;
     }
 
 
@@ -371,7 +371,7 @@ 
             return null;
         }
         $attendee = $this->get_all([$where_cols_n_values]);
-        if (! empty($attendee)) {
+        if ( ! empty($attendee)) {
             return array_shift($attendee);
         }
         return null;

core/db_models/EEM_Datetime.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -656,7 +656,7 @@
     /**
      * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
      *
-     * @param array $include           If included you can restrict the statuses we return counts for by including the
+     * @param string[] $include           If included you can restrict the statuses we return counts for by including the
      *                                 statuses you want counts for as values in the array.  An empty array returns
      *                                 counts for all valid statuses.
      * @param array $query_params      If included can be used to refine the conditions for returning the count (i.e.

Indentation +847 added lines, -847 removed lines

@@ -13,851 +13,851 @@
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A 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 InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = [
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        ];
-        $this->_fields                 = [
-            'Datetime' => [
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'           => new EE_Belongs_To_Relation(),
-            'Checkin'         => new EE_Has_Many_Relation(),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-        ];
-        $path_to_event_model           = 'Event';
-        $this->model_chain_to_password = $path_to_event_model;
-        $this->_model_chain_to_wp_user = $path_to_event_model;
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-                                                                  = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]
-                                                                  = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]
-                                                                  = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     */
-    public function create_new_blank_datetime(): array
-    {
-        // makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        /**
-         * Filters the initial start date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $start_date Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $start_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
-            $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
-        );
-        /**
-         * Filters the initial end date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $end_data Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $end_date       = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
-            $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
-        );
-        $blank_datetime = EE_Datetime::new_instance(
-            [
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ],
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return [$blank_datetime];
-    }
-
-
-    /**
-     * Validates whether the start_time and end_time are in the expected format.
-     *
-     * @param array $start_time
-     * @param array $end_time
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
-    {
-        if (! is_array($start_time)) {
-            throw new InvalidDataTypeException('start_time', $start_time, 'array');
-        }
-        if (! is_array($end_time)) {
-            throw new InvalidDataTypeException('end_time', $end_time, 'array');
-        }
-        if (count($start_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$start_time'
-                )
-            );
-        }
-        if (count($end_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$end_time'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_dates(int $EVT_ID = 0): array
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param int     $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        int $limit = 0
-    ): array {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions($query_params);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetimes_for_event_ordered_by_importance(int $EVT_ID, int $limit = 0): array
-    {
-        $query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params    = $this->addDefaultWhereConditions($query_params);
-        $query_params    = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_oldest_datetime_for_event(
-        int $EVT_ID,
-        bool $include_expired = false,
-        bool $include_deleted = false
-    ): ?EE_Datetime {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_primary_datetime_for_event(
-        int $EVT_ID,
-        bool $try_to_exclude_expired = true,
-        bool $try_to_exclude_deleted = true
-    ): ?EE_Datetime {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        int $limit = 0
-    ): array {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions(
-            $query_params,
-            EEM_Base::default_where_conditions_this_only
-        );
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        int $limit = 0
-    ): array {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param int     $TKT_ID            ID of ticket to retrieve the datetimes for
-     * @param boolean $include_expired   whether to include expired datetimes or not
-     * @param boolean $include_deleted   whether to include trashed datetimes or not.
-     * @param int     $limit             if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        int $limit = 0
-    ): array {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_most_important_datetime_for_event(int $EVT_ID): ?EE_Datetime
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param array  $where_params       @see
-     *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param string $evt_active_status  A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function get_dtt_months_and_years(array $where_params, string $evt_active_status = ''): array
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming':
-                $where_params['Event.status'] = 'publish';
-                // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = ['>', $current_time_for_DTT_EVT_start];
-                break;
-            case 'expired':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                // get events to exclude
-                $exclude_query[0] = array_merge(
-                    $where_params,
-                    ['DTT_EVT_end' => ['>', $current_time_for_DTT_EVT_end]]
-                );
-                // first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = ['<', $current_time_for_DTT_EVT_end];
-                $where_params['Event.EVT_ID'] = ['NOT IN', $event_ids];
-                break;
-            case 'active':
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = ['<', $current_time_for_DTT_EVT_start];
-                $where_params['DTT_EVT_end']   = ['>', $current_time_for_DTT_EVT_end];
-                break;
-            case 'inactive':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = ['!=', 'publish'];
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = ['dtt_year', 'dtt_month'];
-        $query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
-
-        $query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select = [
-            'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
-            'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
-            'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
-        ];
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_sold(array $datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param array $include           If included you can restrict the statuses we return counts for by including the
-     *                                 statuses you want counts for as values in the array.  An empty array returns
-     *                                 counts for all valid statuses.
-     * @param array $query_params      If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     * @throws ReflectionException
-     *                                 statuses used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $include = [], array $query_params = []): array
-    {
-        // only accept where conditions for this query.
-        $_where            = $query_params[0] ?? [];
-        $status_query_args = [
-            EE_Datetime::active   => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['>', time()]]
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                ['DTT_EVT_end' => ['<', time()]]
-            ),
-        ];
-        if (! empty($include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        // loop through and query counts for each statuses.
-        $status_query_results = [];
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                [$status_where_conditions],
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_datetime_count_for_status(string $status = EE_Datetime::active, array $query_params = []): int
-    {
-        $count = $this->get_datetime_counts_by_status([$status], $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
-
-
-    /**
-     * @return bool|int
-     * @since   $VID:$
-     */
-    private function prepModelForQuery()
-    {
-        $prev_data_prep_value = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        return $prev_data_prep_value;
-    }
-
-
-    /**
-     * @param array    $query_params
-     * @param bool|int $prev_data_prep_value
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value): array
-    {
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
-        return $result;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param int    $limit
-     * @param string $order_by
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultQueryParams(
-        array $query_params,
-        int $limit = 0,
-        string $order_by = 'DTT_EVT_start'
-    ): array {
-        $query_params = $this->addOrderByQueryParams($query_params, $order_by);
-        return $this->addLimitQueryParams($query_params, $limit);
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $default_where_conditions
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultWhereConditions(
-        array $query_params,
-        string $default_where_conditions = EEM_Base::default_where_conditions_none
-    ): array {
-        $query_params['default_where_conditions'] = $default_where_conditions;
-        return $query_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @param bool  $include_expired
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDefaultWhereParams(array $where_params,
-                                           bool $include_deleted = true,
-                                           bool $include_expired = true): array
-    {
-        $where_params = $this->addExpiredWhereParams($where_params, $include_expired);
-        return $this->addDeletedWhereParams($where_params, $include_deleted);
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @return array
-     * @since   $VID:$
-     */
-    private function addDeletedWhereParams(array $where_params, bool $include_deleted = true): array
-    {
-        $deleted                     = $include_deleted ? [true, false] : [false];
-        $where_params['DTT_deleted'] = ['IN', $deleted];
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_expired
-     * @return array
-     * @since   $VID:$
-     */
-    private function addExpiredWhereParams(array $where_params, bool $include_expired = true): array
-    {
-        if (! $include_expired) {
-            $where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
-        }
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param int   $limit
-     * @return array
-     * @since   $VID:$
-     */
-    private function addLimitQueryParams(array $query_params, int $limit = 0): array
-    {
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $order_by
-     * @param string $order
-     * @return array
-     * @since   $VID:$
-     */
-    private function addOrderByQueryParams(array $query_params,
-                                           string $order_by = 'DTT_EVT_start',
-                                           string $order = 'ASC'): array
-    {
-        $order                    = $order === 'ASC' ? 'ASC' : 'DESC';
-        $valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
-        $order_by                 = in_array($order_by, $valid_order_columns, true)
-            ? $order_by
-            : 'DTT_EVT_start';
-        $query_params['order_by'] = [$order_by => $order];
-        return $query_params;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A 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 InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = [
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		];
+		$this->_fields                 = [
+			'Datetime' => [
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'           => new EE_Belongs_To_Relation(),
+			'Checkin'         => new EE_Has_Many_Relation(),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+		];
+		$path_to_event_model           = 'Event';
+		$this->model_chain_to_password = $path_to_event_model;
+		$this->_model_chain_to_wp_user = $path_to_event_model;
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+																  = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]
+																  = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]
+																  = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_new_blank_datetime(): array
+	{
+		// makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		/**
+		 * Filters the initial start date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $start_date Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$start_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
+			$this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
+		);
+		/**
+		 * Filters the initial end date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $end_data Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$end_date       = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
+			$this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
+		);
+		$blank_datetime = EE_Datetime::new_instance(
+			[
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			],
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return [$blank_datetime];
+	}
+
+
+	/**
+	 * Validates whether the start_time and end_time are in the expected format.
+	 *
+	 * @param array $start_time
+	 * @param array $end_time
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
+	{
+		if (! is_array($start_time)) {
+			throw new InvalidDataTypeException('start_time', $start_time, 'array');
+		}
+		if (! is_array($end_time)) {
+			throw new InvalidDataTypeException('end_time', $end_time, 'array');
+		}
+		if (count($start_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$start_time'
+				)
+			);
+		}
+		if (count($end_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$end_time'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_dates(int $EVT_ID = 0): array
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param int     $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		int $limit = 0
+	): array {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions($query_params);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetimes_for_event_ordered_by_importance(int $EVT_ID, int $limit = 0): array
+	{
+		$query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params    = $this->addDefaultWhereConditions($query_params);
+		$query_params    = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_oldest_datetime_for_event(
+		int $EVT_ID,
+		bool $include_expired = false,
+		bool $include_deleted = false
+	): ?EE_Datetime {
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_primary_datetime_for_event(
+		int $EVT_ID,
+		bool $try_to_exclude_expired = true,
+		bool $try_to_exclude_deleted = true
+	): ?EE_Datetime {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		int $limit = 0
+	): array {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions(
+			$query_params,
+			EEM_Base::default_where_conditions_this_only
+		);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		int $limit = 0
+	): array {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param int     $TKT_ID            ID of ticket to retrieve the datetimes for
+	 * @param boolean $include_expired   whether to include expired datetimes or not
+	 * @param boolean $include_deleted   whether to include trashed datetimes or not.
+	 * @param int     $limit             if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		int $limit = 0
+	): array {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_most_important_datetime_for_event(int $EVT_ID): ?EE_Datetime
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param array  $where_params       @see
+	 *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param string $evt_active_status  A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function get_dtt_months_and_years(array $where_params, string $evt_active_status = ''): array
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming':
+				$where_params['Event.status'] = 'publish';
+				// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = ['>', $current_time_for_DTT_EVT_start];
+				break;
+			case 'expired':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				// get events to exclude
+				$exclude_query[0] = array_merge(
+					$where_params,
+					['DTT_EVT_end' => ['>', $current_time_for_DTT_EVT_end]]
+				);
+				// first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = ['<', $current_time_for_DTT_EVT_end];
+				$where_params['Event.EVT_ID'] = ['NOT IN', $event_ids];
+				break;
+			case 'active':
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = ['<', $current_time_for_DTT_EVT_start];
+				$where_params['DTT_EVT_end']   = ['>', $current_time_for_DTT_EVT_end];
+				break;
+			case 'inactive':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = ['!=', 'publish'];
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = ['dtt_year', 'dtt_month'];
+		$query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
+
+		$query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select = [
+			'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
+			'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
+			'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
+		];
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_sold(array $datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param array $include           If included you can restrict the statuses we return counts for by including the
+	 *                                 statuses you want counts for as values in the array.  An empty array returns
+	 *                                 counts for all valid statuses.
+	 * @param array $query_params      If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 *                                 statuses used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $include = [], array $query_params = []): array
+	{
+		// only accept where conditions for this query.
+		$_where            = $query_params[0] ?? [];
+		$status_query_args = [
+			EE_Datetime::active   => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['>', time()]]
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				['DTT_EVT_end' => ['<', time()]]
+			),
+		];
+		if (! empty($include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		// loop through and query counts for each statuses.
+		$status_query_results = [];
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				[$status_where_conditions],
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_datetime_count_for_status(string $status = EE_Datetime::active, array $query_params = []): int
+	{
+		$count = $this->get_datetime_counts_by_status([$status], $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @since   $VID:$
+	 */
+	private function prepModelForQuery()
+	{
+		$prev_data_prep_value = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		return $prev_data_prep_value;
+	}
+
+
+	/**
+	 * @param array    $query_params
+	 * @param bool|int $prev_data_prep_value
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value): array
+	{
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
+		return $result;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param int    $limit
+	 * @param string $order_by
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultQueryParams(
+		array $query_params,
+		int $limit = 0,
+		string $order_by = 'DTT_EVT_start'
+	): array {
+		$query_params = $this->addOrderByQueryParams($query_params, $order_by);
+		return $this->addLimitQueryParams($query_params, $limit);
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $default_where_conditions
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultWhereConditions(
+		array $query_params,
+		string $default_where_conditions = EEM_Base::default_where_conditions_none
+	): array {
+		$query_params['default_where_conditions'] = $default_where_conditions;
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDefaultWhereParams(array $where_params,
+										   bool $include_deleted = true,
+										   bool $include_expired = true): array
+	{
+		$where_params = $this->addExpiredWhereParams($where_params, $include_expired);
+		return $this->addDeletedWhereParams($where_params, $include_deleted);
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addDeletedWhereParams(array $where_params, bool $include_deleted = true): array
+	{
+		$deleted                     = $include_deleted ? [true, false] : [false];
+		$where_params['DTT_deleted'] = ['IN', $deleted];
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addExpiredWhereParams(array $where_params, bool $include_expired = true): array
+	{
+		if (! $include_expired) {
+			$where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
+		}
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param int   $limit
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addLimitQueryParams(array $query_params, int $limit = 0): array
+	{
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $order_by
+	 * @param string $order
+	 * @return array
+	 * @since   $VID:$
+	 */
+	private function addOrderByQueryParams(array $query_params,
+										   string $order_by = 'DTT_EVT_start',
+										   string $order = 'ASC'): array
+	{
+		$order                    = $order === 'ASC' ? 'ASC' : 'DESC';
+		$valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
+		$order_by                 = in_array($order_by, $valid_order_columns, true)
+			? $order_by
+			: 'DTT_EVT_start';
+		$query_params['order_by'] = [$order_by => $order];
+		return $query_params;
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -121,7 +121,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'           => new EE_Belongs_To_Relation(),
             'Checkin'         => new EE_Has_Many_Relation(),
@@ -131,18 +131,18 @@ 
         $this->model_chain_to_password = $path_to_event_model;
         $this->_model_chain_to_wp_user = $path_to_event_model;
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                                                                   = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]
                                                                   = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]
                                                                   = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
@@ -184,7 +184,7 @@ 
          * @param int $end_data Unix timestamp representing now + 30 days in seconds.
          * @return int Unix timestamp
          */
-        $end_date       = apply_filters(
+        $end_date = apply_filters(
             'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
             $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
         );
@@ -250,10 +250,10 @@ 
      */
     private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
     {
-        if (! is_array($start_time)) {
+        if ( ! is_array($start_time)) {
             throw new InvalidDataTypeException('start_time', $start_time, 'array');
         }
-        if (! is_array($end_time)) {
+        if ( ! is_array($end_time)) {
             throw new InvalidDataTypeException('end_time', $end_time, 'array');
         }
         if (count($start_time) !== 2) {
@@ -288,7 +288,7 @@ 
      */
     public function get_all_event_dates(int $EVT_ID = 0): array
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -430,7 +430,7 @@ 
             $query_params,
             EEM_Base::default_where_conditions_this_only
         );
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+        $query_params = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
         return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
     }
 
@@ -595,14 +595,14 @@ 
         $query_params['group_by'] = ['dtt_year', 'dtt_month'];
         $query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
 
-        $query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset(
             $this->get_timezone(),
             'DTT_EVT_start'
         );
         $columns_to_select = [
-            'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
-            'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
-            'dtt_month_num' => ['MONTH(' . $query_interval . ')', '%s'],
+            'dtt_year'      => ['YEAR('.$query_interval.')', '%s'],
+            'dtt_month'     => ['MONTHNAME('.$query_interval.')', '%s'],
+            'dtt_month_num' => ['MONTH('.$query_interval.')', '%s'],
         ];
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -685,17 +685,17 @@ 
                 ['DTT_EVT_end' => ['<', time()]]
             ),
         ];
-        if (! empty($include)) {
+        if ( ! empty($include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         // loop through and query counts for each statuses.
         $status_query_results = [];
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 [$status_where_conditions],
                 'DTT_ID',
                 true
@@ -717,7 +717,7 @@ 
     public function get_datetime_count_for_status(string $status = EE_Datetime::active, array $query_params = []): int
     {
         $count = $this->get_datetime_counts_by_status([$status], $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 
 
@@ -819,7 +819,7 @@ 
      */
     private function addExpiredWhereParams(array $where_params, bool $include_expired = true): array
     {
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
         }
         return $where_params;

core/db_models/EEM_Event.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -314,7 +314,7 @@
     /**
      * Used to override the default for the additional limit field.
      *
-     * @param $additional_limit
+     * @param integer $additional_limit
      */
     public static function set_default_additional_limit($additional_limit)
     {

Indentation +948 added lines, -948 removed lines

@@ -14,952 +14,952 @@
 class EEM_Event extends EEM_CPT_Base
 {
 
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     *
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(string $timezone = '')
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item   = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati       = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            [
-                EEM_Event::cancelled => [
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ],
-                EEM_Event::postponed => [
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ],
-                EEM_Event::sold_out  => [
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ],
-            ]
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables             = [
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        ];
-        $this->_fields             = [
-            'Event_CPT'  => [
-                'EVT_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__('Post ID for Event', 'event_espresso')
-                ),
-                'EVT_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_slug'       => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__('Event Slug', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_short_desc' => new EE_Simple_HTML_Field(
-                    'post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'EVT_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field(
-                    'post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false,
-                    'draft',
-                    $this->_custom_stati
-                ),
-                'password'       => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    [
-                        'EVT_desc',
-                        'EVT_short_desc',
-                        'EVT_display_desc',
-                        'EVT_display_ticket_selector',
-                        'EVT_visible_on',
-                        'EVT_additional_limit',
-                        'EVT_default_registration_status',
-                        'EVT_member_only',
-                        'EVT_phone',
-                        'EVT_allow_overflow',
-                        'EVT_timezone_string',
-                        'EVT_external_URL',
-                        'EVT_donations',
-                    ]
-                ),
-            ],
-            'Event_Meta' => [
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field(
-                    'EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
-                    false
-                ),
-                'EVT_display_desc'                => new EE_Boolean_Field(
-                    'EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field(
-                    'EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_visible_on'                  => new EE_Datetime_Field(
-                    'EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    true,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                    false,
-                    EEM_Event::$_default_reg_status,
-                    EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field(
-                    'EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_phone'                       => new EE_Plain_Text_Field(
-                    'EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_allow_overflow'              => new EE_Boolean_Field(
-                    'EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field(
-                    'EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_external_URL'                => new EE_Plain_Text_Field(
-                    'EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
-                    true
-                ),
-                'EVT_donations'                   => new EE_Boolean_Field(
-                    'EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password                            = '';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @param string $default_reg_status
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function set_default_reg_status(string $default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     *
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     *
-     * @return int
-     */
-    public static function get_default_additional_limit(): int
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_question_groups(): array
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                ['QSG_deleted' => false],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_question_groups(int $EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            [
-                ['EVT_ID' => $EVT_ID],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int     $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_question_groups(int $EVT_ID = 0, bool $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $query_params = [
-            [
-                'EVT_ID'                                                                         => $EVT_ID,
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
-            ],
-        ];
-        if ($for_primary_attendee) {
-            $query_params[0]['EQG_primary'] = true;
-        } else {
-            $query_params[0]['EQG_additional'] = true;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_question_groups_for_event(int $EVT_ID, EE_Registration $registration)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID' => $EVT_ID,
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                        $registration->is_primary_registrant()
-                    )                             => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_questions_in_groups(string $QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            [
-                [
-                    'Question_Group.QSG_ID' => ['IN', $QSG_IDs],
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ],
-                'order_by' => 'QST_order',
-            ]
-        );
-    }
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_options_for_question(string $QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            [
-                [
-                    'Question.QST_ID' => ['IN', $QST_IDs],
-                    'QSO_deleted'     => false,
-                ],
-                'order_by' => 'QSO_ID',
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_events(array $query_params, bool $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = ['IN', ['publish', EEM_Event::sold_out]];
-        // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = [
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = [
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_upcoming_events(array $query_params, bool $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        // we need to pull events with a status of publish and sold_out
-        $event_status = ['publish', EEM_Event::sold_out];
-        // check if the user can read private events and if so add the 'private status to the were params'
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
-            $event_status[] = 'private';
-        }
-        $where_params['status'] = ['IN', $event_status];
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_and_upcoming_events(array $query_params, bool $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = ['IN', ['publish', EEM_Event::sold_out]];
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_expired_events(array $query_params, bool $count = false)
-    {
-        $where_params = $query_params[0] ?? [];
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = [
-            'Datetime.DTT_EVT_end' => [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ],
-        ];
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = [
-            'Datetime.DTT_EVT_end' => ['<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')],
-            'EVT_ID'               => ['NOT IN', $event_ids],
-        ];
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0]     = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param array   $query_params  An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param boolean $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_inactive_events(array $query_params, bool $count = false)
-    {
-        $where_params = $query_params[0] ?? [];
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = ['!=', 'publish'];
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $extra_join_model_fields_n_values
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_relationship_to(
-        $id_or_obj,
-        $other_model_id_or_obj,
-        $relationName,
-        $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $price = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $price->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $price->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to(
-                $id_or_obj,
-                $price,
-                $relationName,
-                $extra_join_model_fields_n_values
-            );
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to(
-            $id_or_obj,
-            $other_model_id_or_obj,
-            $relationName,
-            $extra_join_model_fields_n_values
-        );
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @param EE_Registration $registration    (so existing answers for registration are included)
-     * @param int             $EVT_ID          so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @return    array
-     * @throws ReflectionException
-     * @throws EE_Error*@deprecated as of 4.8.32.rc.001. Instead consider using
-     *                                         EE_Registration_Custom_Questions_Form located in
-     *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     */
-    public function assemble_array_of_groups_questions_and_options(
-        EE_Registration $registration,
-        int $EVT_ID = 0
-    ): array {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(
-                __(
-                    'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                    'event_espresso'
-                )
-            );
-        }
-        $questions = [];
-        // get all question groups for event
-        $question_groups = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $question_group) {
-                $QSG_ID = $question_group->ID();
-                $questions[ $QSG_ID ]                  = $question_group->model_field_array();
-                $questions[ $QSG_ID ]['QSG_questions'] = [];
-                $question_groups_questions                           = $question_group->questions();
-                foreach ($question_groups_questions as $question_groups_question) {
-                    if ($question_groups_question->is_system_question()) {
-                        continue;
-                    }
-                    $QGQ_ID = $question_groups_question->ID();
-                    $answer = EEM_Answer::instance()->get_one(
-                        [
-                            [
-                                'QST_ID' => $QGQ_ID,
-                                'REG_ID' => $registration->ID(),
-                            ],
-                        ]
-                    );
-                    $answer = $answer instanceof EE_Answer
-                        ? $answer
-                        : EEM_Answer::instance()->create_default_object();
-                    $question_name = $question_id = $QGQ_ID;
-                    $ANS_ID = $answer->ID();
-                    $question_name = ! empty($ANS_ID)
-                        ? '[' . $question_name . '][' . $ANS_ID . ']'
-                        : '[' . $question_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($question_groups_question->display_text());
-                    $input_class
-                            = '';
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]
-                            = $question_groups_question->model_field_array();
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $question_name;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_id'] = $input_id . '-' . $question_id;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_class'] = $input_class;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'] = [];
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['qst_obj'] = $question_groups_question;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['ans_obj'] = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['htmlentities'] = false;
-                    if (
-                        $question_groups_question->type() == 'RADIO_BTN'
-                        || $question_groups_question->type() == 'CHECKBOX'
-                        || $question_groups_question->type() == 'DROPDOWN'
-                    ) {
-                        $question_options = $question_groups_question->options(true, $answer->value());
-                        if (is_array($question_options)) {
-                            foreach ($question_options as $QSO_ID => $question_option) {
-                                $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'][ $QSO_ID ]
-                                    = $question_option->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 *
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item   = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati       = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			[
+				EEM_Event::cancelled => [
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				],
+				EEM_Event::postponed => [
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				],
+				EEM_Event::sold_out  => [
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				],
+			]
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables             = [
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		];
+		$this->_fields             = [
+			'Event_CPT'  => [
+				'EVT_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__('Post ID for Event', 'event_espresso')
+				),
+				'EVT_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__('Event Name', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_slug'       => new EE_Slug_Field(
+					'post_name',
+					esc_html__('Event Slug', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_short_desc' => new EE_Simple_HTML_Field(
+					'post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0
+				),
+				'EVT_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field(
+					'post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false,
+					'draft',
+					$this->_custom_stati
+				),
+				'password'       => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					[
+						'EVT_desc',
+						'EVT_short_desc',
+						'EVT_display_desc',
+						'EVT_display_ticket_selector',
+						'EVT_visible_on',
+						'EVT_additional_limit',
+						'EVT_default_registration_status',
+						'EVT_member_only',
+						'EVT_phone',
+						'EVT_allow_overflow',
+						'EVT_timezone_string',
+						'EVT_external_URL',
+						'EVT_donations',
+					]
+				),
+			],
+			'Event_Meta' => [
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field(
+					'EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'),
+					false
+				),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
+					'EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
+					false
+				),
+				'EVT_display_desc'                => new EE_Boolean_Field(
+					'EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field(
+					'EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_visible_on'                  => new EE_Datetime_Field(
+					'EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					true,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'),
+					false,
+					EEM_Event::$_default_reg_status,
+					EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field(
+					'EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_phone'                       => new EE_Plain_Text_Field(
+					'EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_allow_overflow'              => new EE_Boolean_Field(
+					'EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field(
+					'EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_external_URL'                => new EE_Plain_Text_Field(
+					'EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
+					true
+				),
+				'EVT_donations'                   => new EE_Boolean_Field(
+					'EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password                            = '';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @param string $default_reg_status
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function set_default_reg_status(string $default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 *
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 *
+	 * @return int
+	 */
+	public static function get_default_additional_limit(): int
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_question_groups(): array
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				['QSG_deleted' => false],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_question_groups(int $EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			[
+				['EVT_ID' => $EVT_ID],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_question_groups(int $EVT_ID = 0, bool $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$query_params = [
+			[
+				'EVT_ID'                                                                         => $EVT_ID,
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
+			],
+		];
+		if ($for_primary_attendee) {
+			$query_params[0]['EQG_primary'] = true;
+		} else {
+			$query_params[0]['EQG_additional'] = true;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups_for_event(int $EVT_ID, EE_Registration $registration)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID' => $EVT_ID,
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext(
+						$registration->is_primary_registrant()
+					)                             => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_questions_in_groups(string $QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			[
+				[
+					'Question_Group.QSG_ID' => ['IN', $QSG_IDs],
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				],
+				'order_by' => 'QST_order',
+			]
+		);
+	}
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_options_for_question(string $QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			[
+				[
+					'Question.QST_ID' => ['IN', $QST_IDs],
+					'QSO_deleted'     => false,
+				],
+				'order_by' => 'QSO_ID',
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_events(array $query_params, bool $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = ['IN', ['publish', EEM_Event::sold_out]];
+		// if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = [
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = [
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_upcoming_events(array $query_params, bool $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		// we need to pull events with a status of publish and sold_out
+		$event_status = ['publish', EEM_Event::sold_out];
+		// check if the user can read private events and if so add the 'private status to the were params'
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
+			$event_status[] = 'private';
+		}
+		$where_params['status'] = ['IN', $event_status];
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_and_upcoming_events(array $query_params, bool $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = ['IN', ['publish', EEM_Event::sold_out]];
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_expired_events(array $query_params, bool $count = false)
+	{
+		$where_params = $query_params[0] ?? [];
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = [
+			'Datetime.DTT_EVT_end' => [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			],
+		];
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = [
+			'Datetime.DTT_EVT_end' => ['<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')],
+			'EVT_ID'               => ['NOT IN', $event_ids],
+		];
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0]     = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param array   $query_params  An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param boolean $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_inactive_events(array $query_params, bool $count = false)
+	{
+		$where_params = $query_params[0] ?? [];
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = ['!=', 'publish'];
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $extra_join_model_fields_n_values
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_relationship_to(
+		$id_or_obj,
+		$other_model_id_or_obj,
+		$relationName,
+		$extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$price = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $price->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$price->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to(
+				$id_or_obj,
+				$price,
+				$relationName,
+				$extra_join_model_fields_n_values
+			);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to(
+			$id_or_obj,
+			$other_model_id_or_obj,
+			$relationName,
+			$extra_join_model_fields_n_values
+		);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @param EE_Registration $registration    (so existing answers for registration are included)
+	 * @param int             $EVT_ID          so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @return    array
+	 * @throws ReflectionException
+	 * @throws EE_Error*@deprecated as of 4.8.32.rc.001. Instead consider using
+	 *                                         EE_Registration_Custom_Questions_Form located in
+	 *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 */
+	public function assemble_array_of_groups_questions_and_options(
+		EE_Registration $registration,
+		int $EVT_ID = 0
+	): array {
+		if (empty($EVT_ID)) {
+			throw new EE_Error(
+				__(
+					'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+					'event_espresso'
+				)
+			);
+		}
+		$questions = [];
+		// get all question groups for event
+		$question_groups = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $question_group) {
+				$QSG_ID = $question_group->ID();
+				$questions[ $QSG_ID ]                  = $question_group->model_field_array();
+				$questions[ $QSG_ID ]['QSG_questions'] = [];
+				$question_groups_questions                           = $question_group->questions();
+				foreach ($question_groups_questions as $question_groups_question) {
+					if ($question_groups_question->is_system_question()) {
+						continue;
+					}
+					$QGQ_ID = $question_groups_question->ID();
+					$answer = EEM_Answer::instance()->get_one(
+						[
+							[
+								'QST_ID' => $QGQ_ID,
+								'REG_ID' => $registration->ID(),
+							],
+						]
+					);
+					$answer = $answer instanceof EE_Answer
+						? $answer
+						: EEM_Answer::instance()->create_default_object();
+					$question_name = $question_id = $QGQ_ID;
+					$ANS_ID = $answer->ID();
+					$question_name = ! empty($ANS_ID)
+						? '[' . $question_name . '][' . $ANS_ID . ']'
+						: '[' . $question_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($question_groups_question->display_text());
+					$input_class
+							= '';
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]
+							= $question_groups_question->model_field_array();
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $question_name;
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_id'] = $input_id . '-' . $question_id;
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_class'] = $input_class;
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'] = [];
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['qst_obj'] = $question_groups_question;
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['ans_obj'] = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['htmlentities'] = false;
+					if (
+						$question_groups_question->type() == 'RADIO_BTN'
+						|| $question_groups_question->type() == 'CHECKBOX'
+						|| $question_groups_question->type() == 'DROPDOWN'
+					) {
+						$question_options = $question_groups_question->options(true, $answer->value());
+						if (is_array($question_options)) {
+							foreach ($question_options as $QSO_ID => $question_option) {
+								$questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'][ $QSO_ID ]
+									= $question_option->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -72,7 +72,7 @@ 
         // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
         // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
         //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati       = apply_filters(
+        $this->_custom_stati = apply_filters(
             'AFEE__EEM_Event__construct___custom_stati',
             [
                 EEM_Event::cancelled => [
@@ -95,7 +95,7 @@ 
             'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
             'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
         ];
-        $this->_fields             = [
+        $this->_fields = [
             'Event_CPT'  => [
                 'EVT_ID'         => new EE_Primary_Key_Int_Field(
                     'ID',
@@ -264,7 +264,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations    = [
+        $this->_model_relations = [
             'Registration'           => new EE_Has_Many_Relation(),
             'Datetime'               => new EE_Has_Many_Relation(),
             'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
@@ -277,7 +277,7 @@ 
             'WP_User'                => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password                            = '';
         parent::__construct($timezone);
     }
@@ -374,7 +374,7 @@ 
      */
     public function get_all_event_question_groups(int $EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -408,7 +408,7 @@ 
      */
     public function get_event_question_groups(int $EVT_ID = 0, bool $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                 // @codingStandardsIgnoreStart
@@ -451,7 +451,7 @@ 
      */
     public function get_question_groups_for_event(int $EVT_ID, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -883,12 +883,12 @@ 
         $questions = [];
         // get all question groups for event
         $question_groups = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $question_group) {
                 $QSG_ID = $question_group->ID();
-                $questions[ $QSG_ID ]                  = $question_group->model_field_array();
-                $questions[ $QSG_ID ]['QSG_questions'] = [];
-                $question_groups_questions                           = $question_group->questions();
+                $questions[$QSG_ID]                  = $question_group->model_field_array();
+                $questions[$QSG_ID]['QSG_questions'] = [];
+                $question_groups_questions = $question_group->questions();
                 foreach ($question_groups_questions as $question_groups_question) {
                     if ($question_groups_question->is_system_question()) {
                         continue;
@@ -908,24 +908,24 @@ 
                     $question_name = $question_id = $QGQ_ID;
                     $ANS_ID = $answer->ID();
                     $question_name = ! empty($ANS_ID)
-                        ? '[' . $question_name . '][' . $ANS_ID . ']'
-                        : '[' . $question_name . ']';
+                        ? '['.$question_name.']['.$ANS_ID.']'
+                        : '['.$question_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($question_groups_question->display_text());
                     $input_class
                             = '';
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]
                             = $question_groups_question->model_field_array();
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_name'] = 'qstn'
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $question_name;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_id'] = $input_id . '-' . $question_id;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_input_class'] = $input_class;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'] = [];
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['qst_obj'] = $question_groups_question;
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['ans_obj'] = $answer;
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['QST_input_id'] = $input_id.'-'.$question_id;
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['QST_input_class'] = $input_class;
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['QST_options'] = [];
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['qst_obj'] = $question_groups_question;
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['ans_obj'] = $answer;
                     // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['htmlentities'] = false;
+                    $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['htmlentities'] = false;
                     if (
                         $question_groups_question->type() == 'RADIO_BTN'
                         || $question_groups_question->type() == 'CHECKBOX'
@@ -934,7 +934,7 @@ 
                         $question_options = $question_groups_question->options(true, $answer->value());
                         if (is_array($question_options)) {
                             foreach ($question_options as $QSO_ID => $question_option) {
-                                $questions[ $QSG_ID ]['QSG_questions'][ $QGQ_ID ]['QST_options'][ $QSO_ID ]
+                                $questions[$QSG_ID]['QSG_questions'][$QGQ_ID]['QST_options'][$QSO_ID]
                                     = $question_option->model_field_array();
                             }
                         }

core/db_models/EEM_Event_Message_Template.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     /**
      * protected constructor to prevent direct creation
      *
-     * @param null $timezone
+     * @param string|null $timezone
      * @throws EE_Error
      */
     protected function __construct(string $timezone = '')

Indentation +104 added lines, -104 removed lines

@@ -12,117 +12,117 @@
 class EEM_Event_Message_Template extends EEM_Base
 {
 
-    // private instance of the EEM_Event_Message_Template object
-    protected static $_instance;
+	// private instance of the EEM_Event_Message_Template object
+	protected static $_instance;
 
 
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Event Message Template', 'event_espresso');
-        $this->plural_item   = esc_html__('Event Message Templates', 'event_espresso');
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Event Message Template', 'event_espresso');
+		$this->plural_item   = esc_html__('Event Message Templates', 'event_espresso');
 
-        $this->_tables          = [
-            'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
-        ];
-        $this->_fields          = [
-            'Event_Message_Template' => [
-                'EMT_ID' => new EE_Primary_Key_Int_Field(
-                    'EMT_ID',
-                    esc_html__('Event Message Template ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('The ID to the Event', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'GRP_ID' => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('The ID to the Message Template Group', 'event_espresso'),
-                    false,
-                    0,
-                    'Message_Template_Group'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'                  => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event          = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
+		$this->_tables          = [
+			'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
+		];
+		$this->_fields          = [
+			'Event_Message_Template' => [
+				'EMT_ID' => new EE_Primary_Key_Int_Field(
+					'EMT_ID',
+					esc_html__('Event Message Template ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('The ID to the Event', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'GRP_ID' => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('The ID to the Message Template Group', 'event_espresso'),
+					false,
+					0,
+					'Message_Template_Group'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'                  => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event          = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * helper method to simply return an array of event ids for events attached to the given
-     * message template group.
-     *
-     * @param int $GRP_ID The MTP group we want attached events for.
-     * @return  array               An array of event ids.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.3.0
-     */
-    public function get_attached_event_ids(int $GRP_ID): array
-    {
-        $event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
-        return call_user_func_array('array_merge', $event_ids);
-    }
+	/**
+	 * helper method to simply return an array of event ids for events attached to the given
+	 * message template group.
+	 *
+	 * @param int $GRP_ID The MTP group we want attached events for.
+	 * @return  array               An array of event ids.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.3.0
+	 */
+	public function get_attached_event_ids(int $GRP_ID): array
+	{
+		$event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
+		return call_user_func_array('array_merge', $event_ids);
+	}
 
 
-    /**
-     * helper method for clearing event/group relations for the given event ids and grp ids.
-     *
-     * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
-     * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
-     * @return int             How many rows were deleted.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_event_group_relations(array $GRP_IDs = [], array $EVT_IDs = []): int
-    {
-        if (empty($GRP_IDs) && empty($EVT_IDs)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
-                        'event_espresso'
-                    ),
-                    __METHOD__
-                )
-            );
-        }
+	/**
+	 * helper method for clearing event/group relations for the given event ids and grp ids.
+	 *
+	 * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
+	 * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
+	 * @return int             How many rows were deleted.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_event_group_relations(array $GRP_IDs = [], array $EVT_IDs = []): int
+	{
+		if (empty($GRP_IDs) && empty($EVT_IDs)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
+						'event_espresso'
+					),
+					__METHOD__
+				)
+			);
+		}
 
-        $where = [];
-        if (! empty($GRP_IDs)) {
-            $where['GRP_ID'] = ['IN', $GRP_IDs];
-        }
-        if (! empty($EVT_IDs)) {
-            $where['EVT_ID'] = ['IN', $EVT_IDs];
-        }
+		$where = [];
+		if (! empty($GRP_IDs)) {
+			$where['GRP_ID'] = ['IN', $GRP_IDs];
+		}
+		if (! empty($EVT_IDs)) {
+			$where['EVT_ID'] = ['IN', $EVT_IDs];
+		}
 
-        return $this->delete([$where], false);
-    }
+		return $this->delete([$where], false);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -56,17 +56,17 @@ 
             'Event'                  => new EE_Belongs_To_Relation(),
             'Message_Template_Group' => new EE_Belongs_To_Relation(),
         ];
-        $path_to_event          = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+        $path_to_event = 'Event';
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event,
             EEM_Base::caps_edit
         );
@@ -116,10 +116,10 @@ 
         }
 
         $where = [];
-        if (! empty($GRP_IDs)) {
+        if ( ! empty($GRP_IDs)) {
             $where['GRP_ID'] = ['IN', $GRP_IDs];
         }
-        if (! empty($EVT_IDs)) {
+        if ( ! empty($EVT_IDs)) {
             $where['EVT_ID'] = ['IN', $EVT_IDs];
         }
 

core/db_models/EEM_Line_Item.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -429,7 +429,7 @@ 
      *
      * @param int $TXN_ID
      * @param int $TKT_ID
-     * @return EE_Line_Item|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -456,7 +456,7 @@ 
      *
      * @param EE_Line_Item $parent_line_item
      * @param EE_Promotion $promotion
-     * @return EE_Line_Item|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -515,7 +515,7 @@ 
      * In order to support that, we'd probably need a LIN_ID on registrations or something.
      *
      * @param EE_Registration $registration
-     * @return EE_Line_Item|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +627 added lines, -627 removed lines

@@ -28,634 +28,634 @@
 class EEM_Line_Item extends EEM_Base
 {
 
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order.
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // various line item object types
-    const OBJ_TYPE_EVENT       = 'Event';
-
-    const OBJ_TYPE_PRICE       = 'Price';
-
-    const OBJ_TYPE_PROMOTION   = 'Promotion';
-
-    const OBJ_TYPE_TICKET      = 'Ticket';
-
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
-
-    /**
-     * @var EEM_Line_Item $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item   = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables                 = [
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
-        ];
-        $line_items_can_be_for         = apply_filters(
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
-            ['Ticket', 'Price', 'Event']
-        );
-        $this->_fields                 = [
-            'Line_Item' => [
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
-                    'LIN_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'LIN_code'       => new EE_Slug_Field(
-                    'LIN_code',
-                    esc_html__('Code for index into Cart', 'event_espresso'),
-                    true
-                ),
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Transaction'
-                ),
-                'LIN_name'       => new EE_Full_HTML_Field(
-                    'LIN_name',
-                    esc_html__('Line Item Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'LIN_desc'       => new EE_Full_HTML_Field(
-                    'LIN_desc',
-                    esc_html__('Line Item Description', 'event_espresso'),
-                    true
-                ),
-                'LIN_unit_price' => new EE_Money_Field(
-                    'LIN_unit_price',
-                    esc_html__('Unit Price', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_percent'    => new EE_Float_Field(
-                    'LIN_percent',
-                    esc_html__('Percent', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_is_taxable' => new EE_Boolean_Field(
-                    'LIN_is_taxable',
-                    esc_html__('Taxable', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'LIN_order'      => new EE_Integer_Field(
-                    'LIN_order',
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_total'      => new EE_Money_Field(
-                    'LIN_total',
-                    esc_html__('Total (unit price x quantity)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_quantity'   => new EE_Integer_Field(
-                    'LIN_quantity',
-                    esc_html__('Quantity', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'LIN_parent'     => new EE_Integer_Field(
-                    'LIN_parent',
-                    esc_html__(
-                        "Parent ID (this item goes towards that Line Item's total)",
-                        'event_espresso'
-                    ),
-                    true,
-                    null
-                ),
-                'LIN_type'       => new EE_Enum_Text_Field(
-                    'LIN_type',
-                    esc_html__('Type', 'event_espresso'),
-                    false,
-                    'line-item',
-                    [
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
-                    ]
-                ),
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'LIN_timestamp'  => new EE_Datetime_Field(
-                    'LIN_timestamp',
-                    esc_html__('When the line item was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
-            'Price'       => new EE_Belongs_To_Any_Relation(),
-            'Event'       => new EE_Belongs_To_Any_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     *
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_of_type_for_transaction(string $line_item_type, $transaction): array
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => $line_item_type,
-                    'TXN_ID'   => $transaction,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     *
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction): array
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => self::type_line_item,
-                    'TXN_ID'   => $transaction,
-                    'OR'       => [
-                        'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
-                        'OBJ_type*null'      => ['IS_NULL'],
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
-     * deleting and joining tables like this.
-     *
-     * @return int count of how many deleted
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_line_items_with_no_transaction(): int
-    {
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query               = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order.
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// various line item object types
+	const OBJ_TYPE_EVENT       = 'Event';
+
+	const OBJ_TYPE_PRICE       = 'Price';
+
+	const OBJ_TYPE_PROMOTION   = 'Promotion';
+
+	const OBJ_TYPE_TICKET      = 'Ticket';
+
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
+
+	/**
+	 * @var EEM_Line_Item $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item   = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables                 = [
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
+		];
+		$line_items_can_be_for         = apply_filters(
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
+			['Ticket', 'Price', 'Event']
+		);
+		$this->_fields                 = [
+			'Line_Item' => [
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
+					'LIN_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'LIN_code'       => new EE_Slug_Field(
+					'LIN_code',
+					esc_html__('Code for index into Cart', 'event_espresso'),
+					true
+				),
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					true,
+					null,
+					'Transaction'
+				),
+				'LIN_name'       => new EE_Full_HTML_Field(
+					'LIN_name',
+					esc_html__('Line Item Name', 'event_espresso'),
+					false,
+					''
+				),
+				'LIN_desc'       => new EE_Full_HTML_Field(
+					'LIN_desc',
+					esc_html__('Line Item Description', 'event_espresso'),
+					true
+				),
+				'LIN_unit_price' => new EE_Money_Field(
+					'LIN_unit_price',
+					esc_html__('Unit Price', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_percent'    => new EE_Float_Field(
+					'LIN_percent',
+					esc_html__('Percent', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_is_taxable' => new EE_Boolean_Field(
+					'LIN_is_taxable',
+					esc_html__('Taxable', 'event_espresso'),
+					false,
+					false
+				),
+				'LIN_order'      => new EE_Integer_Field(
+					'LIN_order',
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_total'      => new EE_Money_Field(
+					'LIN_total',
+					esc_html__('Total (unit price x quantity)', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_quantity'   => new EE_Integer_Field(
+					'LIN_quantity',
+					esc_html__('Quantity', 'event_espresso'),
+					true,
+					1
+				),
+				'LIN_parent'     => new EE_Integer_Field(
+					'LIN_parent',
+					esc_html__(
+						"Parent ID (this item goes towards that Line Item's total)",
+						'event_espresso'
+					),
+					true,
+					null
+				),
+				'LIN_type'       => new EE_Enum_Text_Field(
+					'LIN_type',
+					esc_html__('Type', 'event_espresso'),
+					false,
+					'line-item',
+					[
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
+						self::type_total         => esc_html__('Total', 'event_espresso'),
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
+					]
+				),
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__('ID of Item purchased.', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'LIN_timestamp'  => new EE_Datetime_Field(
+					'LIN_timestamp',
+					esc_html__('When the line item was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
+			'Price'       => new EE_Belongs_To_Any_Relation(),
+			'Event'       => new EE_Belongs_To_Any_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 *
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_of_type_for_transaction(string $line_item_type, $transaction): array
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => $line_item_type,
+					'TXN_ID'   => $transaction,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction): array
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => self::type_line_item,
+					'TXN_ID'   => $transaction,
+					'OR'       => [
+						'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
+						'OBJ_type*null'      => ['IS_NULL'],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
+	 * deleting and joining tables like this.
+	 *
+	 * @return int count of how many deleted
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_line_items_with_no_transaction(): int
+	{
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query               = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int           $TXN_ID
-     * @param EE_Base_Class $object
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_transaction_object(int $TXN_ID, EE_Base_Class $object): array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $TXN_ID,
-                    'OBJ_type' => str_replace('EE_', '', get_class($object)),
-                    'OBJ_ID'   => $object->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int    $TXN_ID
-     * @param string $OBJ_type
-     * @param array  $OBJ_IDs
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_object_line_items_for_transaction(
-        int $TXN_ID,
-        string $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
-        array $OBJ_IDs = []
-    ): array {
-        $query_params = [
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
-        ];
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all([$query_params]);
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction): array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $transaction->ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_ticket_line_item_for_transaction(int $TXN_ID, int $TKT_ID): ?EE_Line_Item
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                    'OBJ_ID'   => $TKT_ID,
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 1.0.0
-     */
-    public function get_existing_promotion_line_item(
-        EE_Line_Item $parent_line_item,
-        EE_Promotion $promotion
-    ): ?EE_Line_Item {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                    'OBJ_ID'     => $promotion->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since   1.0.0
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item): array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     *
-     * @param EE_Registration $registration
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_registration(EE_Registration $registration): ?EE_Line_Item
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     *
-     * @param EE_Registration $registration
-     * @param array           $original_query_params any extra query params you'd like to be merged with
-     * @return array @see
-     *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function line_item_for_registration_query_params(
-        EE_Registration $registration,
-        array $original_query_params = []
-    ): array {
-        return array_replace_recursive(
-            $original_query_params,
-            [
-                [
-                    'OBJ_ID'   => $registration->ticket_ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'TXN_ID'   => $registration->transaction_ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function get_total_line_items_with_no_transaction(): array
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function get_total_line_items_for_active_carts(): array
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function get_total_line_items_for_expired_carts(): array
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param bool|null $expired
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function get_total_line_items_for_carts(bool $expired = null): array
-    {
-        $where_params = [
-            'TXN_ID'   => 0,
-            'LIN_type' => 'total',
-        ];
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan              = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $expired                       = filter_var($expired, FILTER_VALIDATE_BOOLEAN);
-            $where_params['LIN_timestamp'] = [
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            ];
-        }
-        return $this->get_all([$where_params]);
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function getTicketLineItemsForExpiredCarts(int $timestamp = 0): array
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp        = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => ['<=', $timestamp],
-                ],
-            ]
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int           $TXN_ID
+	 * @param EE_Base_Class $object
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_transaction_object(int $TXN_ID, EE_Base_Class $object): array
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $TXN_ID,
+					'OBJ_type' => str_replace('EE_', '', get_class($object)),
+					'OBJ_ID'   => $object->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int    $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array  $OBJ_IDs
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_object_line_items_for_transaction(
+		int $TXN_ID,
+		string $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
+		array $OBJ_IDs = []
+	): array {
+		$query_params = [
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
+		];
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all([$query_params]);
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction): array
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $transaction->ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_line_item_for_transaction(int $TXN_ID, int $TKT_ID): ?EE_Line_Item
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+					'OBJ_ID'   => $TKT_ID,
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 1.0.0
+	 */
+	public function get_existing_promotion_line_item(
+		EE_Line_Item $parent_line_item,
+		EE_Promotion $promotion
+	): ?EE_Line_Item {
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+					'OBJ_ID'     => $promotion->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since   1.0.0
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item): array
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration): ?EE_Line_Item
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
+	 * @return array @see
+	 *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function line_item_for_registration_query_params(
+		EE_Registration $registration,
+		array $original_query_params = []
+	): array {
+		return array_replace_recursive(
+			$original_query_params,
+			[
+				[
+					'OBJ_ID'   => $registration->ticket_ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'TXN_ID'   => $registration->transaction_ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function get_total_line_items_with_no_transaction(): array
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function get_total_line_items_for_active_carts(): array
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function get_total_line_items_for_expired_carts(): array
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param bool|null $expired
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function get_total_line_items_for_carts(bool $expired = null): array
+	{
+		$where_params = [
+			'TXN_ID'   => 0,
+			'LIN_type' => 'total',
+		];
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan              = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$expired                       = filter_var($expired, FILTER_VALIDATE_BOOLEAN);
+			$where_params['LIN_timestamp'] = [
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			];
+		}
+		return $this->get_all([$where_params]);
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function getTicketLineItemsForExpiredCarts(int $timestamp = 0): array
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp        = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => ['<=', $timestamp],
+				],
+			]
+		);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -134,7 +134,7 @@ 
             'FHEE__EEM_Line_Item__line_items_can_be_for',
             ['Ticket', 'Price', 'Event']
         );
-        $this->_fields                 = [
+        $this->_fields = [
             'Line_Item' => [
                 'LIN_ID'         => new EE_Primary_Key_Int_Field(
                     'LIN_ID',
@@ -246,7 +246,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Transaction' => new EE_Belongs_To_Relation(),
             'Ticket'      => new EE_Belongs_To_Any_Relation(),
             'Price'       => new EE_Belongs_To_Any_Relation(),
@@ -333,10 +333,10 @@ 
             'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
             WEEK_IN_SECONDS
         );
-        $query               = $wpdb->prepare(
+        $query = $wpdb->prepare(
             'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
             // use GMT time because that's what TXN_timestamps are in
             date('Y-m-d H:i:s', time() - $time_to_leave_alone)
@@ -641,7 +641,7 @@ 
      */
     public function getTicketLineItemsForExpiredCarts(int $timestamp = 0): array
     {
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'

core/db_models/EEM_Message_Template_Group.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -395,7 +395,7 @@
     /**
      * This sends things to the validator for the given messenger and message type.
      *
-     * @param array  $fields       the incoming fields to check.
+     * @param string  $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

Indentation +478 added lines, -478 removed lines

@@ -12,482 +12,482 @@
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance;
-
-
-    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/message type 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
-     *
-     * @param int      $EVT_ID specific event id
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @return EE_Message_Template_Group[]|int message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        int $EVT_ID,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $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
-     *
-     * @param string $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return EE_Message_Template_Group[] all (including trashed or inactive) message template group objects for the
-     * given messenger
-     */
-    public function get_all_message_templates_by_messenger(string $messenger,
-                                                           string $orderby = 'GRP_ID',
-                                                           string $order = 'ASC'): array
-    {
-        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 $_POST global
-     *
-     * @param array $_where any existing where conditions to append these to.
-     * @return EE_Message_Template_Group[] original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters(array $_where = []): array
-    {
-        // account for messenger or message type filters
-        if (
-            isset($_REQUEST['ee_messenger_filter_by'])
-            && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
-            && $_REQUEST['ee_messenger_filter_by'] != 'all'
-        ) {
-            $_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
-        }
-
-        if (
-            isset($_REQUEST['ee_message_type_filter_by'])
-            && $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
-        }
-
-        return $_where;
-    }
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @param bool     $global
-     * @param bool     $user_check
-     * @return EE_Message_Template_Group[]|int all active (non_trashed, active) message template objects
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $global = true,
-        bool $user_check = false
-    ): array {
-        $_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 int|null $limit
-     * @param bool     $count
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_all_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false
-    ): array {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-    }
-
-
-    /**
-     * 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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_custom_templates_by_event(int $EVT_ID, array $query_params = []): array
-    {
-        $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
-     *
-     * @param string   $orderby
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count
-     * @param bool     $global
-     * @return EE_Message_Template_Group[]|int message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $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 int      $evt_id
-     * @param string   $orderby pointless at this point but still included
-     * @param string   $order
-     * @param int|null $limit
-     * @param bool     $count   true = just return count, false = objects
-     * @param bool     $active  ignore "active" or not. (default only return active)
-     * @return EE_Message_Template_Group[]|int depending on $count.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        string $messenger,
-        string $message_type,
-        int $evt_id,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $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 int|null $limit
-     * @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 EE_Message_Template_Group[]|int               message template objects that are global (i.e. non-event)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_global_message_template_by_m_and_mt(
-        string $messenger,
-        string $message_type,
-        string $orderby = 'GRP_ID',
-        string $order = 'ASC',
-        int $limit = null,
-        bool $count = false,
-        bool $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
-     * @param string $message_type
-     * @param array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_custom_message_template_by_m_and_mt(string $messenger, string $message_type, array $query_params = []): array
-    {
-        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 mixed If the fields all check out then we return true otherwise error messages are returned
-     *                             (indexed by field name);
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validate(array $fields, string $context, string $messenger, string $message_type)
-    {
-
-        $assembled_fields = [];
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref  = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref  = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (! class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a      = new ReflectionClass($classname);
-        $_VLD   = $a->newInstance($assembled_fields, $context);
-        return $_VLD->validate();
-    }
-
-
-    /**
-     * 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.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deactivate_message_template_groups_for(
-        array $messenger_names = [],
-        array $message_type_names = []
-    ): int {
-        $query_args = [];
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = ['IN', $messenger_names];
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
-        }
-        return $this->update(['MTP_is_active' => false], $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance;
+
+
+	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/message type 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
+	 *
+	 * @param int      $EVT_ID specific event id
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @return EE_Message_Template_Group[]|int message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		int $EVT_ID,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $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
+	 *
+	 * @param string $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return EE_Message_Template_Group[] all (including trashed or inactive) message template group objects for the
+	 * given messenger
+	 */
+	public function get_all_message_templates_by_messenger(string $messenger,
+														   string $orderby = 'GRP_ID',
+														   string $order = 'ASC'): array
+	{
+		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 $_POST global
+	 *
+	 * @param array $_where any existing where conditions to append these to.
+	 * @return EE_Message_Template_Group[] original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters(array $_where = []): array
+	{
+		// account for messenger or message type filters
+		if (
+			isset($_REQUEST['ee_messenger_filter_by'])
+			&& $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
+			&& $_REQUEST['ee_messenger_filter_by'] != 'all'
+		) {
+			$_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
+		}
+
+		if (
+			isset($_REQUEST['ee_message_type_filter_by'])
+			&& $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
+		}
+
+		return $_where;
+	}
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @param bool     $global
+	 * @param bool     $user_check
+	 * @return EE_Message_Template_Group[]|int all active (non_trashed, active) message template objects
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $global = true,
+		bool $user_check = false
+	): array {
+		$_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 int|null $limit
+	 * @param bool     $count
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_all_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false
+	): array {
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+	}
+
+
+	/**
+	 * 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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_custom_templates_by_event(int $EVT_ID, array $query_params = []): array
+	{
+		$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
+	 *
+	 * @param string   $orderby
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count
+	 * @param bool     $global
+	 * @return EE_Message_Template_Group[]|int message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $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 int      $evt_id
+	 * @param string   $orderby pointless at this point but still included
+	 * @param string   $order
+	 * @param int|null $limit
+	 * @param bool     $count   true = just return count, false = objects
+	 * @param bool     $active  ignore "active" or not. (default only return active)
+	 * @return EE_Message_Template_Group[]|int depending on $count.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		string $messenger,
+		string $message_type,
+		int $evt_id,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $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 int|null $limit
+	 * @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 EE_Message_Template_Group[]|int               message template objects that are global (i.e. non-event)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		string $messenger,
+		string $message_type,
+		string $orderby = 'GRP_ID',
+		string $order = 'ASC',
+		int $limit = null,
+		bool $count = false,
+		bool $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
+	 * @param string $message_type
+	 * @param array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_custom_message_template_by_m_and_mt(string $messenger, string $message_type, array $query_params = []): array
+	{
+		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 mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                             (indexed by field name);
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validate(array $fields, string $context, string $messenger, string $message_type)
+	{
+
+		$assembled_fields = [];
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref  = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref  = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (! class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a      = new ReflectionClass($classname);
+		$_VLD   = $a->newInstance($assembled_fields, $context);
+		return $_VLD->validate();
+	}
+
+
+	/**
+	 * 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.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deactivate_message_template_groups_for(
+		array $messenger_names = [],
+		array $message_type_names = []
+	): int {
+		$query_args = [];
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = ['IN', $messenger_names];
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
+		}
+		return $this->update(['MTP_is_active' => false], $query_args);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -88,7 +88,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';
 
@@ -418,19 +418,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -440,9 +440,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -482,10 +482,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', $messenger_names];
         }
-        if (! empty($message_type_names)) {
+        if ( ! empty($message_type_names)) {
             $query_args[0]['MTP_message_type'] = ['IN', $message_type_names];
         }
         return $this->update(['MTP_is_active' => false], $query_args);