eventespresso / event-espresso-core

core/db_models/EEM_CPT_Base.model.php

Indentation +567 added lines, -567 removed lines

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

Spacing +31 added lines, -31 removed lines

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

core/db_models/EEM_Ticket.model.php

Indentation +494 added lines, -494 removed lines

@@ -10,498 +10,498 @@
 class EEM_Ticket extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * the following constants define where tickets can be viewed throughout the UI
-     *
-     *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
-     *  TICKET_VISIBILITY_PUBLIC        - displayed basically anywhere
-     *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged in user
-     *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged in user that is an admin
-     *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
-     */
-    public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
-
-    public const TICKET_VISIBILITY_NONE_VALUE          = 0;
-
-    public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
-
-    public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
-
-
-    /**
-     * defines where tickets can be viewed throughout the UI
-     *
-     * @var array
-     */
-    private $ticket_visibility;
-
-    /**
-     * private instance of the EEM_Ticket object
-     *
-     * @var EEM_Ticket $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @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
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket', 'event_espresso');
-        $this->plural_item   = esc_html__('Tickets', 'event_espresso');
-        $this->_tables       = [
-            'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
-        ];
-        $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
-            'Ticket' => [
-                'TKT_ID'                => new EE_Primary_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso')
-                ),
-                'TTM_ID'                => new EE_Foreign_Key_Int_Field(
-                    'TTM_ID',
-                    esc_html__('Ticket Template ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket_Template'
-                ),
-                'TKT_name'              => new EE_Plain_Text_Field(
-                    'TKT_name',
-                    esc_html__('Ticket Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_description'       => new EE_Post_Content_Field(
-                    'TKT_description',
-                    esc_html__('Description of Ticket', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_start_date'        => new EE_Datetime_Field(
-                    'TKT_start_date',
-                    esc_html__('Start time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_end_date'          => new EE_Datetime_Field(
-                    'TKT_end_date',
-                    esc_html__('End time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_min'               => new EE_Integer_Field(
-                    'TKT_min',
-                    esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_max'               => new EE_Infinite_Integer_Field(
-                    'TKT_max',
-                    esc_html__(
-                        'Maximum quantity of this ticket that can be purchased in one transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_INF
-                ),
-                'TKT_price'             => new EE_Money_Field(
-                    'TKT_price',
-                    esc_html__('Final calculated price for ticket', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_sold'              => new EE_Integer_Field(
-                    'TKT_sold',
-                    esc_html__('Number of this ticket sold', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_qty'               => new EE_Infinite_Integer_Field(
-                    'TKT_qty',
-                    esc_html__('Quantity of this ticket that is available', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_reserved'          => new EE_Integer_Field(
-                    'TKT_reserved',
-                    esc_html__(
-                        'Quantity of this ticket that is reserved, but not yet fully purchased',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_uses'              => new EE_Infinite_Integer_Field(
-                    'TKT_uses',
-                    esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_required'          => new EE_Boolean_Field(
-                    'TKT_required',
-                    esc_html__(
-                        'Flag indicating whether this ticket must be purchased with a transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_taxable'           => new EE_Boolean_Field(
-                    'TKT_taxable',
-                    esc_html__(
-                        'Flag indicating whether there is tax applied on this ticket',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_is_default'        => new EE_Boolean_Field(
-                    'TKT_is_default',
-                    esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_order'             => new EE_Integer_Field(
-                    'TKT_order',
-                    esc_html__(
-                        'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_row'               => new EE_Integer_Field(
-                    'TKT_row',
-                    esc_html__('How tickets are displayed in the ui', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_deleted'           => new EE_Trashed_Flag_Field(
-                    'TKT_deleted',
-                    esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_wp_user'           => new EE_WP_User_Field(
-                    'TKT_wp_user',
-                    esc_html__('Ticket Creator ID', 'event_espresso'),
-                    false
-                ),
-                'TKT_parent'            => new EE_Integer_Field(
-                    'TKT_parent',
-                    esc_html__(
-                        'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'TKT_reverse_calculate' => new EE_Boolean_Field(
-                    'TKT_reverse_calculate',
-                    esc_html__(
-                        'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_visibility'        => new EE_Enum_Integer_Field(
-                    'TKT_visibility',
-                    esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
-                    false,
-                    EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                    $this->getTicketVisibilityEnumOptions()
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Price'           => new EE_HABTM_Relation('Ticket_Price'),
-            'Ticket_Template' => new EE_Belongs_To_Relation(),
-            'Registration'    => new EE_Has_Many_Relation(),
-            'WP_User'         => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                            = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
-            'TKT_is_default',
-            $path_to_event
-        );
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-            = new EE_Restriction_Generator_Default_Protected(
-                'TKT_is_default',
-                $path_to_event
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->model_chain_to_password                              = $path_to_event;
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * override parent class get_all() just to fix return types in IDE
-     *
-     * @param array $query_params
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function get_all($query_params = []): array
-    {
-        return parent::get_all($query_params);
-    }
-
-
-    /**
-     * This returns all tickets that are defaults from the db
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_default_tickets(): array
-    {
-        $tickets = $this->get_all(
-            [
-                [
-                    'TKT_is_default' => 1,
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-                'order_by' => ['TKT_ID' => 'ASC'],
-            ]
-        );
-        // we need to set the start date and end date to today's date and the start of the default dtt
-        return $this->_set_default_dates($tickets);
-    }
-
-
-    /**
-     * sets up relevant start and end date for EE_Ticket (s)
-     *
-     * @param EE_Ticket[] $tickets
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_default_dates(array $tickets): array
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->set(
-                'TKT_start_date',
-                (int) $this->current_time_for_query('TKT_start_date', true)
-            );
-            $ticket->set(
-                'TKT_end_date',
-                (int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
-            );
-            $ticket->set_end_time(
-                $this->convert_datetime_for_query(
-                    'TKT_end_date',
-                    '11:59 pm',
-                    'g:i a',
-                    $this->_timezone
-                )
-            );
-        }
-        return $tickets;
-    }
-
-
-    /**
-     * Gets the total number of tickets available at a particular datetime (does
-     * NOT take int account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
-    {
-        $query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
-        return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold quantity on all the tickets matching $query_params
-     *
-     * @param EE_Ticket[] $tickets
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_tickets_sold(array $tickets)
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->update_tickets_sold();
-        }
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_reservations(): array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_reserved'   => ['>', 0],
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects matching the supplied list of IDs
-     *
-     * @param array $ticket_IDs
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_IDs(array $ticket_IDs): array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_ID' => ['IN', $ticket_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function parseTicketVisibilityOptions()
-    {
-        $this->ticket_visibility = (array) apply_filters(
-            'FHEE__EEM_Ticket__construct__ticket_visibility',
-            [
-                EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
-                    'label' => esc_html__('Public', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
-                    'label' => esc_html__('Members only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
-                    'label' => esc_html__('Admins only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
-                    'label' => esc_html__('Admin UI only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
-                    'label' => esc_html__('None', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityEnumOptions(): array
-    {
-        $ticket_visibility = [];
-        foreach ($this->ticket_visibility as $visibility) {
-            if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
-            }
-        }
-        return $ticket_visibility;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityValues(): array
-    {
-        // copy ticket_visibility array
-        $ticket_visibility_options = $this->ticket_visibility;
-        foreach ($ticket_visibility_options as $ticket_visibility_option) {
-            // remove labels because we only want the values
-            unset($ticket_visibility_option['label']);
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityLabels(): array
-    {
-        $ticket_visibility_options = [];
-        foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
-            if (isset($ticket_visibility_option['label'])) {
-                // change because we only want the labels tied to the keys
-                $ticket_visibility_options[] = [
-                    'value' => $key,
-                    'label' => $ticket_visibility_option['label']
-                ];
-            }
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ticketVisibilityOptions(): array
-    {
-        return $this->ticket_visibility;
-    }
+	/**
+	 * the following constants define where tickets can be viewed throughout the UI
+	 *
+	 *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
+	 *  TICKET_VISIBILITY_PUBLIC        - displayed basically anywhere
+	 *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged in user
+	 *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged in user that is an admin
+	 *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
+	 */
+	public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
+
+	public const TICKET_VISIBILITY_NONE_VALUE          = 0;
+
+	public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
+
+	public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
+
+
+	/**
+	 * defines where tickets can be viewed throughout the UI
+	 *
+	 * @var array
+	 */
+	private $ticket_visibility;
+
+	/**
+	 * private instance of the EEM_Ticket object
+	 *
+	 * @var EEM_Ticket $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @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
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket', 'event_espresso');
+		$this->plural_item   = esc_html__('Tickets', 'event_espresso');
+		$this->_tables       = [
+			'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
+		];
+		$this->parseTicketVisibilityOptions();
+		$this->_fields          = [
+			'Ticket' => [
+				'TKT_ID'                => new EE_Primary_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso')
+				),
+				'TTM_ID'                => new EE_Foreign_Key_Int_Field(
+					'TTM_ID',
+					esc_html__('Ticket Template ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket_Template'
+				),
+				'TKT_name'              => new EE_Plain_Text_Field(
+					'TKT_name',
+					esc_html__('Ticket Name', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_description'       => new EE_Post_Content_Field(
+					'TKT_description',
+					esc_html__('Description of Ticket', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_start_date'        => new EE_Datetime_Field(
+					'TKT_start_date',
+					esc_html__('Start time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_end_date'          => new EE_Datetime_Field(
+					'TKT_end_date',
+					esc_html__('End time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_min'               => new EE_Integer_Field(
+					'TKT_min',
+					esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_max'               => new EE_Infinite_Integer_Field(
+					'TKT_max',
+					esc_html__(
+						'Maximum quantity of this ticket that can be purchased in one transaction',
+						'event_espresso'
+					),
+					false,
+					EE_INF
+				),
+				'TKT_price'             => new EE_Money_Field(
+					'TKT_price',
+					esc_html__('Final calculated price for ticket', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_sold'              => new EE_Integer_Field(
+					'TKT_sold',
+					esc_html__('Number of this ticket sold', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_qty'               => new EE_Infinite_Integer_Field(
+					'TKT_qty',
+					esc_html__('Quantity of this ticket that is available', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_reserved'          => new EE_Integer_Field(
+					'TKT_reserved',
+					esc_html__(
+						'Quantity of this ticket that is reserved, but not yet fully purchased',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_uses'              => new EE_Infinite_Integer_Field(
+					'TKT_uses',
+					esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_required'          => new EE_Boolean_Field(
+					'TKT_required',
+					esc_html__(
+						'Flag indicating whether this ticket must be purchased with a transaction',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_taxable'           => new EE_Boolean_Field(
+					'TKT_taxable',
+					esc_html__(
+						'Flag indicating whether there is tax applied on this ticket',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_is_default'        => new EE_Boolean_Field(
+					'TKT_is_default',
+					esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_order'             => new EE_Integer_Field(
+					'TKT_order',
+					esc_html__(
+						'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_row'               => new EE_Integer_Field(
+					'TKT_row',
+					esc_html__('How tickets are displayed in the ui', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_deleted'           => new EE_Trashed_Flag_Field(
+					'TKT_deleted',
+					esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_wp_user'           => new EE_WP_User_Field(
+					'TKT_wp_user',
+					esc_html__('Ticket Creator ID', 'event_espresso'),
+					false
+				),
+				'TKT_parent'            => new EE_Integer_Field(
+					'TKT_parent',
+					esc_html__(
+						'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'TKT_reverse_calculate' => new EE_Boolean_Field(
+					'TKT_reverse_calculate',
+					esc_html__(
+						'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_visibility'        => new EE_Enum_Integer_Field(
+					'TKT_visibility',
+					esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
+					false,
+					EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+					$this->getTicketVisibilityEnumOptions()
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Price'           => new EE_HABTM_Relation('Ticket_Price'),
+			'Ticket_Template' => new EE_Belongs_To_Relation(),
+			'Registration'    => new EE_Has_Many_Relation(),
+			'WP_User'         => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                            = 'Datetime.Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+			'TKT_is_default',
+			$path_to_event
+		);
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+			= new EE_Restriction_Generator_Default_Protected(
+				'TKT_is_default',
+				$path_to_event
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->model_chain_to_password                              = $path_to_event;
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * override parent class get_all() just to fix return types in IDE
+	 *
+	 * @param array $query_params
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function get_all($query_params = []): array
+	{
+		return parent::get_all($query_params);
+	}
+
+
+	/**
+	 * This returns all tickets that are defaults from the db
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_default_tickets(): array
+	{
+		$tickets = $this->get_all(
+			[
+				[
+					'TKT_is_default' => 1,
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+				'order_by' => ['TKT_ID' => 'ASC'],
+			]
+		);
+		// we need to set the start date and end date to today's date and the start of the default dtt
+		return $this->_set_default_dates($tickets);
+	}
+
+
+	/**
+	 * sets up relevant start and end date for EE_Ticket (s)
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_default_dates(array $tickets): array
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->set(
+				'TKT_start_date',
+				(int) $this->current_time_for_query('TKT_start_date', true)
+			);
+			$ticket->set(
+				'TKT_end_date',
+				(int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
+			);
+			$ticket->set_end_time(
+				$this->convert_datetime_for_query(
+					'TKT_end_date',
+					'11:59 pm',
+					'g:i a',
+					$this->_timezone
+				)
+			);
+		}
+		return $tickets;
+	}
+
+
+	/**
+	 * Gets the total number of tickets available at a particular datetime (does
+	 * NOT take int account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
+	{
+		$query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
+		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold quantity on all the tickets matching $query_params
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_tickets_sold(array $tickets)
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->update_tickets_sold();
+		}
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_reservations(): array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_reserved'   => ['>', 0],
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects matching the supplied list of IDs
+	 *
+	 * @param array $ticket_IDs
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_IDs(array $ticket_IDs): array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_ID' => ['IN', $ticket_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function parseTicketVisibilityOptions()
+	{
+		$this->ticket_visibility = (array) apply_filters(
+			'FHEE__EEM_Ticket__construct__ticket_visibility',
+			[
+				EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
+					'label' => esc_html__('Public', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
+					'label' => esc_html__('Members only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
+					'label' => esc_html__('Admins only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
+					'label' => esc_html__('Admin UI only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
+					'label' => esc_html__('None', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityEnumOptions(): array
+	{
+		$ticket_visibility = [];
+		foreach ($this->ticket_visibility as $visibility) {
+			if (isset($visibility['value'], $visibility['label'])) {
+				$ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+			}
+		}
+		return $ticket_visibility;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityValues(): array
+	{
+		// copy ticket_visibility array
+		$ticket_visibility_options = $this->ticket_visibility;
+		foreach ($ticket_visibility_options as $ticket_visibility_option) {
+			// remove labels because we only want the values
+			unset($ticket_visibility_option['label']);
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityLabels(): array
+	{
+		$ticket_visibility_options = [];
+		foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
+			if (isset($ticket_visibility_option['label'])) {
+				// change because we only want the labels tied to the keys
+				$ticket_visibility_options[] = [
+					'value' => $key,
+					'label' => $ticket_visibility_option['label']
+				];
+			}
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ticketVisibilityOptions(): array
+	{
+		return $this->ticket_visibility;
+	}
 }

core/db_models/EEM_Message.model.php

Indentation +632 added lines, -632 removed lines

@@ -10,643 +10,643 @@
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
 
-    // private instance of the Message object
-    protected static $_instance;
+	// private instance of the Message object
+	protected static $_instance;
 
 
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @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 ReflectionException
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        // used for token generator
-        EE_Registry::instance()->load_helper('URL');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_default_object(): ?EE_Message
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values): ?EE_Message
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function message_sent_for_attendee($attendee, string $message_type): bool
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function message_sent_for_registration($registration, string $message_type): bool
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_by_token(string $token): EE_Message
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = EE_Registry::instance()->REQ->get($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model = EE_Registry::instance()->load_model($model_name);
-            if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @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 ReflectionException
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		// used for token generator
+		EE_Registry::instance()->load_helper('URL');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_default_object(): ?EE_Message
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values): ?EE_Message
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function message_sent_for_attendee($attendee, string $message_type): bool
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function message_sent_for_registration($registration, string $message_type): bool
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_by_token(string $token): EE_Message
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = EE_Registry::instance()->REQ->get($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model = EE_Registry::instance()->load_model($model_name);
+			if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

core/db_models/fields/EE_Field_With_Model_Name.php

Indentation +83 added lines, -83 removed lines

@@ -8,97 +8,97 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string|string[]
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string|string[]
+	 */
+	protected $_model_name_pointed_to;
 
 
-    /**
-     * @param string       $table_column  name fo column for field
-     * @param string       $nice_name     should be internationalized with esc_html__('blah','event_espresso')
-     * @param boolean      $nullable
-     * @param mixed        $default_value if this is a integer field, it should be an int.
-     *                                    if it's a string field, it should be a string
-     * @param string|array $model_name    eg 'Event', 'Answer', 'Term', etc.
-     *                                    Basically its the model class's name without the "EEM_"
-     */
-    public function __construct($table_column, $nice_name, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-    }
+	/**
+	 * @param string       $table_column  name fo column for field
+	 * @param string       $nice_name     should be internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean      $nullable
+	 * @param mixed        $default_value if this is a integer field, it should be an int.
+	 *                                    if it's a string field, it should be a string
+	 * @param string|array $model_name    eg 'Event', 'Answer', 'Term', etc.
+	 *                                    Basically its the model class's name without the "EEM_"
+	 */
+	public function __construct($table_column, $nice_name, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+	}
 
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @return string|string[]
-     * @deprecated since version 4.6.7
-     */
-    public function get_model_name_pointed_to()
-    {
-        EE_Error::doing_it_wrong(
-            'get_model_name_pointed_to',
-            esc_html__(
-                'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @return string|string[]
+	 * @deprecated since version 4.6.7
+	 */
+	public function get_model_name_pointed_to()
+	{
+		EE_Error::doing_it_wrong(
+			'get_model_name_pointed_to',
+			esc_html__(
+				'This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return $this->_model_name_pointed_to;
+	}
 
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return string|string[] of model names pointed to by this field
-     */
-    public function get_model_names_pointed_to()
-    {
-        if (is_array($this->_model_name_pointed_to)) {
-            return $this->_model_name_pointed_to;
-        } else {
-            return [$this->_model_name_pointed_to];
-        }
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return string|string[] of model names pointed to by this field
+	 */
+	public function get_model_names_pointed_to()
+	{
+		if (is_array($this->_model_name_pointed_to)) {
+			return $this->_model_name_pointed_to;
+		} else {
+			return [$this->_model_name_pointed_to];
+		}
+	}
 
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return string[]
-     */
-    public function get_model_class_names_pointed_to(): array
-    {
-        $model_names = [];
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return string[]
+	 */
+	public function get_model_class_names_pointed_to(): array
+	{
+		$model_names = [];
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = ["EE_" . $this->_model_name_pointed_to];
+		}
+		return $model_names;
+	}
 
 
-    /**
-     * @param $model_obj_or_ID
-     * @return bool
-     */
-    public function is_model_obj_of_type_pointed_to($model_obj_or_ID): bool
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj_or_ID instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param $model_obj_or_ID
+	 * @return bool
+	 */
+	public function is_model_obj_of_type_pointed_to($model_obj_or_ID): bool
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -79,10 +79,10 @@
         $model_names = [];
         if (is_array($this->_model_name_pointed_to)) {
             foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
+                $model_names[] = "EE_".$model_name;
             }
         } else {
-            $model_names = ["EE_" . $this->_model_name_pointed_to];
+            $model_names = ["EE_".$this->_model_name_pointed_to];
         }
         return $model_names;
     }

core/db_models/fields/EE_WP_Post_Type_Field.php.php

Indentation +8 added lines, -8 removed lines

@@ -5,12 +5,12 @@
  */
 class EE_WP_Post_Type_Field extends EE_DB_Only_Text_Field
 {
-    /**
-     * @param string $post_type the exact string to be used for the post type
-     *                          of all these post type model objects/rows
-     */
-    public function __construct($post_type)
-    {
-        parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
-    }
+	/**
+	 * @param string $post_type the exact string to be used for the post type
+	 *                          of all these post type model objects/rows
+	 */
+	public function __construct($post_type)
+	{
+		parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
+	}
 }

core/db_models/fields/EE_Enum_Text_Field.php

Indentation +127 added lines, -127 removed lines

@@ -11,131 +11,131 @@
 class EE_Enum_Text_Field extends EE_Text_Field_Base
 {
 
-    /**
-     * @var array $_allowed_enum_values
-     */
-    public $_allowed_enum_values;
-
-    /**
-     * @param string  $table_column
-     * @param string  $nice_name
-     * @param boolean $nullable
-     * @param mixed   $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = $allowed_enum_values;
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
-
-
-
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values()
-    {
-        return apply_filters(
-            'FHEE__EE_Enum_Text_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
-
-
-
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default).
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     * @throws EE_Error
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values())
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(
-                    esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    esc_html__('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($this->_allowed_enum_values())),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param     int |string $value_on_field_to_be_outputted
-     * @param    null         $schema
-     * @return    string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        if (isset($options[ $value_on_field_to_be_outputted ])) {
-            return $options[ $value_on_field_to_be_outputted ];
-        } else {
-            return $value_on_field_to_be_outputted;
-        }
-    }
-
-
-
-    /**
-     * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live
-     * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY
-     * when we're receiving USER input from prepare_for_set() that we enforce the enum options.
-     *
-     * @param mixed $value_in_db
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_in_db)
-    {
-        return $value_in_db;
-    }
-
-
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'enum' => array_keys($this->_allowed_enum_values)
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'enum' => array_values($this->_allowed_enum_values),
-                'read_only' => true
-            )
-        );
-    }
+	/**
+	 * @var array $_allowed_enum_values
+	 */
+	public $_allowed_enum_values;
+
+	/**
+	 * @param string  $table_column
+	 * @param string  $nice_name
+	 * @param boolean $nullable
+	 * @param mixed   $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = $allowed_enum_values;
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
+
+
+
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values()
+	{
+		return apply_filters(
+			'FHEE__EE_Enum_Text_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
+
+
+
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default).
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values())
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(
+					esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					esc_html__('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($this->_allowed_enum_values())),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param     int |string $value_on_field_to_be_outputted
+	 * @param    null         $schema
+	 * @return    string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		if (isset($options[ $value_on_field_to_be_outputted ])) {
+			return $options[ $value_on_field_to_be_outputted ];
+		} else {
+			return $value_on_field_to_be_outputted;
+		}
+	}
+
+
+
+	/**
+	 * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live
+	 * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY
+	 * when we're receiving USER input from prepare_for_set() that we enforce the enum options.
+	 *
+	 * @param mixed $value_in_db
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_in_db)
+	{
+		return $value_in_db;
+	}
+
+
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'enum' => array_keys($this->_allowed_enum_values)
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'enum' => array_values($this->_allowed_enum_values),
+				'read_only' => true
+			)
+		);
+	}
 }

core/db_models/fields/EE_Boolean_Field.php

Indentation +57 added lines, -57 removed lines

@@ -2,69 +2,69 @@
 
 class EE_Boolean_Field extends EE_Integer_Field
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct(string $table_column, string $nicename, bool $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('boolean');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct(string $table_column, string $nicename, bool $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('boolean');
+	}
 
 
-    /**
-     * Double-checks the value being returned is an boolean.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function prepare_for_get($value_of_field_on_model_object): bool
-    {
-        return (bool) parent::prepare_for_get($value_of_field_on_model_object);
-    }
+	/**
+	 * Double-checks the value being returned is an boolean.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function prepare_for_get($value_of_field_on_model_object): bool
+	{
+		return (bool) parent::prepare_for_get($value_of_field_on_model_object);
+	}
 
 
-    /**
-     * @param $value_inputted_for_field_on_model_object
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object): bool
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * @param $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object): bool
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
 
 
-    /**
-     * Make sure we're returning booleans
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object): bool
-    {
-        return (bool) intval($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * Make sure we're returning booleans
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object): bool
+	{
+		return (bool) intval($value_inputted_for_field_on_model_object);
+	}
 
 
-    /**
-     * Gets a nice Yes/No value for this field
-     *
-     * @param boolean $value_on_field_to_be_outputted
-     * @return string Yes or No
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted): string
-    {
-        return apply_filters(
-            'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
-            $value_on_field_to_be_outputted
-                ? esc_html__('Yes', 'event_espresso')
-                : esc_html__('No', 'event_espresso'),
-            $value_on_field_to_be_outputted
-        );
-    }
+	/**
+	 * Gets a nice Yes/No value for this field
+	 *
+	 * @param boolean $value_on_field_to_be_outputted
+	 * @return string Yes or No
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted): string
+	{
+		return apply_filters(
+			'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
+			$value_on_field_to_be_outputted
+				? esc_html__('Yes', 'event_espresso')
+				: esc_html__('No', 'event_espresso'),
+			$value_on_field_to_be_outputted
+		);
+	}
 }

core/db_models/fields/EE_All_Caps_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
  */
 class EE_All_Caps_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * makes it all upper case, and key-like
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object): string
-    {
-        return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * makes it all upper case, and key-like
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object): string
+	{
+		return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_Enum_Integer_Field.php

Indentation +102 added lines, -102 removed lines

@@ -9,115 +9,115 @@
  */
 class EE_Enum_Integer_Field extends EE_Integer_Field
 {
-    /**
-     * @var array $_allowed_enum_values
-     */
-    public $_allowed_enum_values;
+	/**
+	 * @var array $_allowed_enum_values
+	 */
+	public $_allowed_enum_values;
 
 
-    /**
-     * @param string  $table_column
-     * @param string  $nicename
-     * @param boolean $nullable
-     * @param int     $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = $allowed_enum_values;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string  $table_column
+	 * @param string  $nicename
+	 * @param boolean $nullable
+	 * @param int     $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = $allowed_enum_values;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values()
-    {
-        return (array) apply_filters(
-            'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values()
+	{
+		return (array) apply_filters(
+			'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
 
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
-     *
-     * @param int $value_inputted_for_field_on_model_object
-     * @return int
-     * @throws EE_Error
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $allowed_enum_values = $this->_allowed_enum_values();
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(
-                    esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($allowed_enum_values)),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return (int) $value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
+	 *
+	 * @param int $value_inputted_for_field_on_model_object
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$allowed_enum_values = $this->_allowed_enum_values();
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(
+					esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($allowed_enum_values)),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return (int) $value_inputted_for_field_on_model_object;
+	}
 
 
 
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param int | string $value_on_field_to_be_outputted
-     * @param null         $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        if (isset($options[ $value_on_field_to_be_outputted ])) {
-            return $options[ $value_on_field_to_be_outputted ];
-        } else {
-            return $value_on_field_to_be_outputted;
-        }
-    }
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param int | string $value_on_field_to_be_outputted
+	 * @param null         $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		if (isset($options[ $value_on_field_to_be_outputted ])) {
+			return $options[ $value_on_field_to_be_outputted ];
+		} else {
+			return $value_on_field_to_be_outputted;
+		}
+	}
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum' => array_keys($this->_allowed_enum_values()),
-                'type' => 'integer'
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum' => array_values($this->_allowed_enum_values()),
-                'type' => 'string',
-                'read_only' => true
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum' => array_keys($this->_allowed_enum_values()),
+				'type' => 'integer'
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum' => array_values($this->_allowed_enum_values()),
+				'type' => 'string',
+				'read_only' => true
+			)
+		);
+	}
 }