eventespresso / event-espresso-core

core/db_models/EEM_Event_Venue.model.php

Indentation +30 added lines, -30 removed lines

@@ -8,36 +8,36 @@
  */
 class EEM_Event_Venue extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = __('Event to Question Group Link', 'event_espresso');
-        $this->plural_item = __('Event to Question Group Links', 'event_espresso');
-        $this->_tables = array(
-            'Event_Venue' => new EE_Primary_Table('esp_event_venue', 'EVV_ID')
-        );
-        $this->_fields = array(
-            'Event_Venue' => array(
-                'EVV_ID' => new EE_Primary_Key_Int_Field('EVV_ID', __('Event to Venue Link ID', 'event_espresso')),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
-                'VNU_ID' => new EE_Foreign_Key_Int_Field('VNU_ID', __('Venue ID', 'event_espresso'), false, 0, 'Venue'),
-                'EVV_primary' => new EE_Boolean_Field('EVV_primary', __("Flag indicating venue is primary one for event", "event_espresso"), false, true)
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = __('Event to Question Group Link', 'event_espresso');
+		$this->plural_item = __('Event to Question Group Links', 'event_espresso');
+		$this->_tables = array(
+			'Event_Venue' => new EE_Primary_Table('esp_event_venue', 'EVV_ID')
+		);
+		$this->_fields = array(
+			'Event_Venue' => array(
+				'EVV_ID' => new EE_Primary_Key_Int_Field('EVV_ID', __('Event to Venue Link ID', 'event_espresso')),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
+				'VNU_ID' => new EE_Foreign_Key_Int_Field('VNU_ID', __('Venue ID', 'event_espresso'), false, 0, 'Venue'),
+				'EVV_primary' => new EE_Boolean_Field('EVV_primary', __("Flag indicating venue is primary one for event", "event_espresso"), false, true)
 
-            )
-        );
-        $this->_model_relations = array(
-            'Event' => new EE_Belongs_To_Relation(),
-            'Venue' => new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
-        $this->model_chain_to_password = $path_to_event;
-        parent::__construct($timezone);
-    }
+			)
+		);
+		$this->_model_relations = array(
+			'Event' => new EE_Belongs_To_Relation(),
+			'Venue' => new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$path_to_event = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
+		$this->model_chain_to_password = $path_to_event;
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_CPT_Base.model.php

Indentation +561 added lines, -561 removed lines

@@ -15,565 +15,565 @@
 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' => __('Status Name', 'event_espresso'),
-     *            'public' => TRUE //whether a public status or not.
-     *        )
-     * )
-     *
-     * @var array
-     */
-    protected $_custom_stati = array();
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($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',
-                __("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',
-                __('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',
-                __('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',
-                __('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',
-                __('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',
-                __('Post Content Filtered', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_model_relations['Post_Meta'])) {
-            // don't block deletes though because we want to maintain the current behaviour
-            $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
-        }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
-        }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            // it's ok for child classes to specify this, but generally this is more DRY
-            $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function public_event_stati()
-    {
-        // @see wp-includes/post.php
-        return get_post_stati(array('public' => true));
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        throw new EE_Error(
-            sprintf(
-                __(
-                    "EEM_CPT_Base should nto 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()
-    {
-        $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        return $query_params;
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean success
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $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(array($post_status_field_name => $new_status), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * meta_table
-     * returns first EE_Secondary_Table table name
-     *
-     * @access public
-     * @return string
-     */
-    public function meta_table()
-    {
-        $meta_table = $this->_get_other_tables();
-        $meta_table = reset($meta_table);
-        return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
-    }
-
-
-    /**
-     * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
-     *
-     * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
-     *                   db only fields)
-     * @return array
-     */
-    public function get_meta_table_fields($all = false)
-    {
-        $all_fields = $fields_to_return = array();
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
-            }
-        }
-        if (! $all) {
-            foreach ($all_fields as $name => $obj) {
-                if ($obj instanceof EE_DB_Only_Field_Base) {
-                    continue;
-                }
-                $fields_to_return[] = $name;
-            }
-        } else {
-            $fields_to_return = array_keys($all_fields);
-        }
-        return $fields_to_return;
-    }
-
-
-    /**
-     * Adds an event category with the specified name and description to the specified
-     * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
-     * and adds an entry in the term_relationship if necessary.
-     *
-     * @param EE_CPT_Base $cpt_model_object
-     * @param string      $category_name (used to derive the term slug too)
-     * @param string      $category_description
-     * @param int         $parent_term_taxonomy_id
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category(
-        EE_CPT_Base $cpt_model_object,
-        $category_name,
-        $category_description = '',
-        $parent_term_taxonomy_id = null
-    ) {
-        // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
-        // first, check for a term by the same name or slug
-        $category_slug = sanitize_title($category_name);
-        $term = EEM_Term::instance()->get_one(
-            array(
-                array(
-                    'OR' => array(
-                        'name' => $category_name,
-                        'slug' => $category_slug,
-                    ),
-                    'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
-                ),
-            )
-        );
-        if (! $term) {
-            $term = EE_Term::new_instance(
-                array(
-                    '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(
-            array(
-                array(
-                    '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(
-                array(
-                    'term_id'     => $term->ID(),
-                    'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
-                    'description' => $category_description,
-                    'term_count'       => 1,
-                    'parent'      => $parent_term_taxonomy_id,
-                )
-            );
-            $term_taxonomy->save();
-        } else {
-            $term_taxonomy->set_count($term_taxonomy->count() + 1);
-            $term_taxonomy->save();
-        }
-        return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * Removed the category specified by name as having a relation to this event.
-     * Does not remove the term or term_taxonomy.
-     *
-     * @param EE_CPT_Base $cpt_model_object_event
-     * @param string      $category_name name of the event category (term)
-     * @return bool
-     */
-    public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
-    {
-        // find the term_taxonomy by that name
-        $term_taxonomy = $this->get_first_related(
-            $cpt_model_object_event,
-            'Term_Taxonomy',
-            array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if ($term_taxonomy) {
-            $term_taxonomy->set_count($term_taxonomy->count() - 1);
-            $term_taxonomy->save();
-        }
-        return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
-     * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access public
-     * @param int          $id   the ID for the cpt we want the feature image for
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    public function get_feature_image($id, $size = 'thumbnail', $attr = '')
-    {
-        return get_the_post_thumbnail($id, $size, $attr);
-    }
-
-
-    /**
-     * Just a handy way to get the list of post statuses currently registered with WP.
-     *
-     * @global array $wp_post_statuses set in wp core for storing all the post stati
-     * @return array
-     */
-    public function get_post_statuses()
-    {
-        global $wp_post_statuses;
-        $statuses = array();
-        foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
-        }
-        return $statuses;
-    }
-
-
-    /**
-     * public method that can be used to retrieve the protected status array on the instantiated cpt model
-     *
-     * @return array array of statuses.
-     */
-    public function get_status_array()
-    {
-        $statuses = $this->get_post_statuses();
-        // first the global filter
-        $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
-        // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
-        return $statuses;
-    }
-
-
-    /**
-     * this returns the post statuses that are NOT the default wordpress status
-     *
-     * @return array
-     */
-    public function get_custom_post_statuses()
-    {
-        $new_stati = array();
-        foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
-        }
-        return $new_stati;
-    }
-
-
-    /**
-     * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
-     * are a row from the posts table. If we're missing any fields required for the model,
-     * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
-     * make sure you are attaching all the model's fields onto the post)
-     *
-     * @param WP_Post|array $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object_orig($post)
-    {
-        $post = (array) $post;
-        $has_all_necessary_fields_for_table = true;
-        // check if the post has fields on the meta table already
-        foreach ($this->_get_other_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $has_all_necessary_fields_for_table = false;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
-            return $this->get_one_by_ID($post['ID']);
-        } else {
-            return $this->instantiate_class_from_array_or_object($post);
-        }
-    }
-
-
-    /**
-     * @param null $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object($post = null)
-    {
-        if (empty($post)) {
-            global $post;
-        }
-        $post = (array) $post;
-        $tables_needing_to_be_queried = array();
-        // 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',
-                    array(
-                        '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
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function post_type()
-    {
-        $post_type_field = null;
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_WP_Post_Type_Field) {
-                $post_type_field = $field_obj;
-                break;
-            }
-        }
-        if ($post_type_field == null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "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' => __('Status Name', 'event_espresso'),
+	 *            'public' => TRUE //whether a public status or not.
+	 *        )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_custom_stati = array();
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($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',
+				__("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',
+				__('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',
+				__('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',
+				__('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',
+				__('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',
+				__('Post Content Filtered', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_model_relations['Post_Meta'])) {
+			// don't block deletes though because we want to maintain the current behaviour
+			$this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
+		}
+		if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
+		}
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			// it's ok for child classes to specify this, but generally this is more DRY
+			$this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function public_event_stati()
+	{
+		// @see wp-includes/post.php
+		return get_post_stati(array('public' => true));
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		throw new EE_Error(
+			sprintf(
+				__(
+					"EEM_CPT_Base should nto 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()
+	{
+		$field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		return $query_params;
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean success
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$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(array($post_status_field_name => $new_status), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * meta_table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function meta_table()
+	{
+		$meta_table = $this->_get_other_tables();
+		$meta_table = reset($meta_table);
+		return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
+	 *
+	 * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
+	 *                   db only fields)
+	 * @return array
+	 */
+	public function get_meta_table_fields($all = false)
+	{
+		$all_fields = $fields_to_return = array();
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
+			}
+		}
+		if (! $all) {
+			foreach ($all_fields as $name => $obj) {
+				if ($obj instanceof EE_DB_Only_Field_Base) {
+					continue;
+				}
+				$fields_to_return[] = $name;
+			}
+		} else {
+			$fields_to_return = array_keys($all_fields);
+		}
+		return $fields_to_return;
+	}
+
+
+	/**
+	 * Adds an event category with the specified name and description to the specified
+	 * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
+	 * and adds an entry in the term_relationship if necessary.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object
+	 * @param string      $category_name (used to derive the term slug too)
+	 * @param string      $category_description
+	 * @param int         $parent_term_taxonomy_id
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category(
+		EE_CPT_Base $cpt_model_object,
+		$category_name,
+		$category_description = '',
+		$parent_term_taxonomy_id = null
+	) {
+		// create term
+		require_once(EE_MODELS . 'EEM_Term.model.php');
+		// first, check for a term by the same name or slug
+		$category_slug = sanitize_title($category_name);
+		$term = EEM_Term::instance()->get_one(
+			array(
+				array(
+					'OR' => array(
+						'name' => $category_name,
+						'slug' => $category_slug,
+					),
+					'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
+				),
+			)
+		);
+		if (! $term) {
+			$term = EE_Term::new_instance(
+				array(
+					'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(
+			array(
+				array(
+					'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(
+				array(
+					'term_id'     => $term->ID(),
+					'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
+					'description' => $category_description,
+					'term_count'       => 1,
+					'parent'      => $parent_term_taxonomy_id,
+				)
+			);
+			$term_taxonomy->save();
+		} else {
+			$term_taxonomy->set_count($term_taxonomy->count() + 1);
+			$term_taxonomy->save();
+		}
+		return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * Removed the category specified by name as having a relation to this event.
+	 * Does not remove the term or term_taxonomy.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object_event
+	 * @param string      $category_name name of the event category (term)
+	 * @return bool
+	 */
+	public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
+	{
+		// find the term_taxonomy by that name
+		$term_taxonomy = $this->get_first_related(
+			$cpt_model_object_event,
+			'Term_Taxonomy',
+			array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if ($term_taxonomy) {
+			$term_taxonomy->set_count($term_taxonomy->count() - 1);
+			$term_taxonomy->save();
+		}
+		return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
+	 * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access public
+	 * @param int          $id   the ID for the cpt we want the feature image for
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	public function get_feature_image($id, $size = 'thumbnail', $attr = '')
+	{
+		return get_the_post_thumbnail($id, $size, $attr);
+	}
+
+
+	/**
+	 * Just a handy way to get the list of post statuses currently registered with WP.
+	 *
+	 * @global array $wp_post_statuses set in wp core for storing all the post stati
+	 * @return array
+	 */
+	public function get_post_statuses()
+	{
+		global $wp_post_statuses;
+		$statuses = array();
+		foreach ($wp_post_statuses as $post_status => $args_object) {
+			$statuses[ $post_status ] = $args_object->label;
+		}
+		return $statuses;
+	}
+
+
+	/**
+	 * public method that can be used to retrieve the protected status array on the instantiated cpt model
+	 *
+	 * @return array array of statuses.
+	 */
+	public function get_status_array()
+	{
+		$statuses = $this->get_post_statuses();
+		// first the global filter
+		$statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
+		// now the class specific filter
+		$statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+		return $statuses;
+	}
+
+
+	/**
+	 * this returns the post statuses that are NOT the default wordpress status
+	 *
+	 * @return array
+	 */
+	public function get_custom_post_statuses()
+	{
+		$new_stati = array();
+		foreach ($this->_custom_stati as $status => $props) {
+			$new_stati[ $status ] = $props['label'];
+		}
+		return $new_stati;
+	}
+
+
+	/**
+	 * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
+	 * are a row from the posts table. If we're missing any fields required for the model,
+	 * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
+	 * make sure you are attaching all the model's fields onto the post)
+	 *
+	 * @param WP_Post|array $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object_orig($post)
+	{
+		$post = (array) $post;
+		$has_all_necessary_fields_for_table = true;
+		// check if the post has fields on the meta table already
+		foreach ($this->_get_other_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$has_all_necessary_fields_for_table = false;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if (! $has_all_necessary_fields_for_table) {
+			return $this->get_one_by_ID($post['ID']);
+		} else {
+			return $this->instantiate_class_from_array_or_object($post);
+		}
+	}
+
+
+	/**
+	 * @param null $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object($post = null)
+	{
+		if (empty($post)) {
+			global $post;
+		}
+		$post = (array) $post;
+		$tables_needing_to_be_queried = array();
+		// 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',
+					array(
+						'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
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function post_type()
+	{
+		$post_type_field = null;
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_WP_Post_Type_Field) {
+				$post_type_field = $field_obj;
+				break;
+			}
+		}
+		if ($post_type_field == null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"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();
+	}
 }

core/db_models/EEM_Question_Group.model.php

Indentation +124 added lines, -124 removed lines

@@ -10,136 +10,136 @@
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
 
-    const system_personal = 1;
+	const system_personal = 1;
 
-    const system_address = 2;
+	const system_address = 2;
 
-    /**
-     * private instance of the EEM_Question_Group object
-     *
-     * @var EEM_Question_Group
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Question_Group object
+	 *
+	 * @var EEM_Question_Group
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * EEM_Question_Group constructor.
-     *
-     * @param string|null $timezone
-     */
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Group', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Groups', 'event_espresso');
+	/**
+	 * EEM_Question_Group constructor.
+	 *
+	 * @param string|null $timezone
+	 */
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Group', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Groups', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Group' => [
-                'QSG_ID'              => new EE_Primary_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group ID', 'event_espresso')
-                ),
-                'QSG_deleted'         => new EE_Trashed_Flag_Field(
-                    'QSG_deleted',
-                    esc_html__('Flag indicating this question group was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSG_desc'            => new EE_Post_Content_Field(
-                    'QSG_desc',
-                    esc_html__('Description of Question Group', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QSG_identifier'      => new EE_Plain_Text_Field(
-                    'QSG_identifier',
-                    esc_html__('Text ID for question Group', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSG_name'            => new EE_Plain_Text_Field(
-                    'QSG_name',
-                    esc_html__('Question Group Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSG_order'           => new EE_Integer_Field(
-                    'QSG_order',
-                    esc_html__('Order in which to show the question group', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'QSG_show_group_desc' => new EE_Boolean_Field(
-                    'QSG_show_group_desc',
-                    esc_html__(
-                        'Flag indicating whether to show the group\s description on the registration page',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'QSG_show_group_name' => new EE_Boolean_Field(
-                    'QSG_show_group_name',
-                    esc_html__(
-                        'Flag indicating whether to show the group\'s name on the registration page',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-                'QSG_system'          => new EE_Integer_Field(
-                    'QSG_system',
-                    esc_html__(
-                        'Indicate IF this is a system group and if it is what system group it corresponds to.',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'QSG_wp_user'         => new EE_WP_User_Field(
-                    'QSG_wp_user',
-                    esc_html__('Question Group Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'                => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group' => new EE_Has_Many_Relation(),
-            'Question'             => new EE_HABTM_Relation('Question_Group_Question'),
-            'WP_User'              => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_tables          = [
+			'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID'),
+		];
+		$this->_fields          = [
+			'Question_Group' => [
+				'QSG_ID'              => new EE_Primary_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group ID', 'event_espresso')
+				),
+				'QSG_deleted'         => new EE_Trashed_Flag_Field(
+					'QSG_deleted',
+					esc_html__('Flag indicating this question group was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QSG_desc'            => new EE_Post_Content_Field(
+					'QSG_desc',
+					esc_html__('Description of Question Group', 'event_espresso'),
+					true,
+					''
+				),
+				'QSG_identifier'      => new EE_Plain_Text_Field(
+					'QSG_identifier',
+					esc_html__('Text ID for question Group', 'event_espresso'),
+					false,
+					''
+				),
+				'QSG_name'            => new EE_Plain_Text_Field(
+					'QSG_name',
+					esc_html__('Question Group Name', 'event_espresso'),
+					false,
+					''
+				),
+				'QSG_order'           => new EE_Integer_Field(
+					'QSG_order',
+					esc_html__('Order in which to show the question group', 'event_espresso'),
+					true,
+					0
+				),
+				'QSG_show_group_desc' => new EE_Boolean_Field(
+					'QSG_show_group_desc',
+					esc_html__(
+						'Flag indicating whether to show the group\s description on the registration page',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'QSG_show_group_name' => new EE_Boolean_Field(
+					'QSG_show_group_name',
+					esc_html__(
+						'Flag indicating whether to show the group\'s name on the registration page',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+				'QSG_system'          => new EE_Integer_Field(
+					'QSG_system',
+					esc_html__(
+						'Indicate IF this is a system group and if it is what system group it corresponds to.',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'QSG_wp_user'         => new EE_WP_User_Field(
+					'QSG_wp_user',
+					esc_html__('Question Group Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'                => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group' => new EE_Has_Many_Relation(),
+			'Question'             => new EE_HABTM_Relation('Question_Group_Question'),
+			'WP_User'              => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * searches the db for the question group with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_latest_question_group_order(): int
-    {
-        $max = $this->_get_all_wpdb_results(
-            [],
-            ARRAY_A,
-            [
-                'max_order' => ["MAX(QSG_order)", "%d"],
-            ]
-        );
-        return $max[0]['max_order'];
-    }
+	/**
+	 * searches the db for the question group with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_latest_question_group_order(): int
+	{
+		$max = $this->_get_all_wpdb_results(
+			[],
+			ARRAY_A,
+			[
+				'max_order' => ["MAX(QSG_order)", "%d"],
+			]
+		);
+		return $max[0]['max_order'];
+	}
 }

core/db_models/EEM_Registration_Payment.model.php

Indentation +23 added lines, -23 removed lines

@@ -13,34 +13,34 @@
 class EEM_Registration_Payment extends EEM_Base
 {
 
-    // private instance
-    protected static $_instance = null;
+	// private instance
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = '')
-    {
+	protected function __construct($timezone = '')
+	{
 
-        $this->singular_item = __('Registration Payment', 'event_espresso');
-        $this->plural_item  = __('Registration Payments', 'event_espresso');
+		$this->singular_item = __('Registration Payment', 'event_espresso');
+		$this->plural_item  = __('Registration Payments', 'event_espresso');
 
-        $this->_tables = array(
-            'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID')
-        );
+		$this->_tables = array(
+			'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID')
+		);
 
-        $this->_fields = array(
-            'Registration_Payment' => array(
-                'RPY_ID'                => new EE_Primary_Key_Int_Field('RPY_ID', __('Registration Payment ID', 'event_espresso')),
-                'REG_ID'                => new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso'), false, 0, 'Registration'),
-                'PAY_ID'                => new EE_Foreign_Key_Int_Field('PAY_ID', __('Payment ID', 'event_espresso'), true, null, 'Payment'),
-                'RPY_amount'    => new EE_Money_Field('RPY_amount', __('Amount attributed to the registration', 'event_espresso'), false, 0),
-            )
-        );
+		$this->_fields = array(
+			'Registration_Payment' => array(
+				'RPY_ID'                => new EE_Primary_Key_Int_Field('RPY_ID', __('Registration Payment ID', 'event_espresso')),
+				'REG_ID'                => new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso'), false, 0, 'Registration'),
+				'PAY_ID'                => new EE_Foreign_Key_Int_Field('PAY_ID', __('Payment ID', 'event_espresso'), true, null, 'Payment'),
+				'RPY_amount'    => new EE_Money_Field('RPY_amount', __('Amount attributed to the registration', 'event_espresso'), false, 0),
+			)
+		);
 
-        $this->_model_relations = array(
-            'Registration'  => new EE_Belongs_To_Relation(),
-            'Payment'       => new EE_Belongs_To_Relation(),
-        );
+		$this->_model_relations = array(
+			'Registration'  => new EE_Belongs_To_Relation(),
+			'Payment'       => new EE_Belongs_To_Relation(),
+		);
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Term_Relationship.model.php

Indentation +223 added lines, -223 removed lines

@@ -10,233 +10,233 @@
 class EEM_Term_Relationship extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-
-
-    /**
-     * EEM_Term_Relationship constructor.
-     *
-     * @param string $timezone
-     */
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = __('Term Relationship', 'event_espresso');
-        $this->plural_item = __('Term Relationships', 'event_espresso');
-        $this->_tables = array(
-            'Term_Relationship' => new EE_Primary_Table('term_relationships'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Term_Relationship' => array(
-                'object_id'        => new EE_Foreign_Key_Int_Field(
-                    'object_id',
-                    __('Object(Post) ID', 'event_espresso'),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
-                    'term_taxonomy_id',
-                    __(
-                        'Term (in context of a taxonomy) ID',
-                        'event_espresso'
-                    ),
-                    false,
-                    0,
-                    'Term_Taxonomy'
-                ),
-                'term_order'       => new EE_Integer_Field(
-                    'term_order',
-                    __('Term Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Term_Taxonomy' => new EE_Belongs_To_Relation(),
-        );
-        foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model = true;
-        $this->_indexes = array(
-            'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')),
-        );
-        $path_to_event_model = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                EEM_Base::caps_edit
-            );
-        $path_to_tax_model = 'Term_Taxonomy.';
-        // add cap restrictions for editing term relations to the "ee_assign_*"
-        // and for deleting term relations too
-        $cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete);
-        foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
-                new EE_Default_Where_Conditions(
-                    array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => array(
-                            '!=',
-                            'espresso_event_categories',
-                        ),
-                    )
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
-                new EE_Default_Where_Conditions(
-                    array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array(
-                            '!=',
-                            'espresso_venue_categories',
-                        ),
-                    )
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
-                array(
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
-                )
-            );
-        }
-        parent::__construct($timezone);
-        add_filter(
-            'FHEE__Read__create_model_query_params',
-            array('EEM_Term_Relationship', 'rest_api_query_params'),
-            10,
-            3
-        );
-    }
-
-
-    /**
-     * Makes sure all term-taxonomy counts are correct
-     *
-     * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
-     * @global wpdb $wpdb
-     * @return int the number of rows affected
-     * @throws EE_Error
-     */
-    public function update_term_taxonomy_counts($term_taxonomy_id = null)
-    {
-        // because this uses a subquery and sometimes assigning to column to be another column's
-        // value, we just write the SQL directly.
-        global $wpdb;
-
-        $query = "
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+
+
+	/**
+	 * EEM_Term_Relationship constructor.
+	 *
+	 * @param string $timezone
+	 */
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = __('Term Relationship', 'event_espresso');
+		$this->plural_item = __('Term Relationships', 'event_espresso');
+		$this->_tables = array(
+			'Term_Relationship' => new EE_Primary_Table('term_relationships'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Term_Relationship' => array(
+				'object_id'        => new EE_Foreign_Key_Int_Field(
+					'object_id',
+					__('Object(Post) ID', 'event_espresso'),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
+					'term_taxonomy_id',
+					__(
+						'Term (in context of a taxonomy) ID',
+						'event_espresso'
+					),
+					false,
+					0,
+					'Term_Taxonomy'
+				),
+				'term_order'       => new EE_Integer_Field(
+					'term_order',
+					__('Term Order', 'event_espresso'),
+					false,
+					0
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Term_Taxonomy' => new EE_Belongs_To_Relation(),
+		);
+		foreach ($models_this_can_attach_to as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model = true;
+		$this->_indexes = array(
+			'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')),
+		);
+		$path_to_event_model = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				EEM_Base::caps_edit
+			);
+		$path_to_tax_model = 'Term_Taxonomy.';
+		// add cap restrictions for editing term relations to the "ee_assign_*"
+		// and for deleting term relations too
+		$cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete);
+		foreach ($cap_contexts_affected as $cap_context_affected) {
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+				new EE_Default_Where_Conditions(
+					array(
+						$path_to_tax_model . 'taxonomy*ee_assign_event_category' => array(
+							'!=',
+							'espresso_event_categories',
+						),
+					)
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+				new EE_Default_Where_Conditions(
+					array(
+						$path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array(
+							'!=',
+							'espresso_venue_categories',
+						),
+					)
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
+				array(
+					$path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
+				)
+			);
+		}
+		parent::__construct($timezone);
+		add_filter(
+			'FHEE__Read__create_model_query_params',
+			array('EEM_Term_Relationship', 'rest_api_query_params'),
+			10,
+			3
+		);
+	}
+
+
+	/**
+	 * Makes sure all term-taxonomy counts are correct
+	 *
+	 * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+	 * @global wpdb $wpdb
+	 * @return int the number of rows affected
+	 * @throws EE_Error
+	 */
+	public function update_term_taxonomy_counts($term_taxonomy_id = null)
+	{
+		// because this uses a subquery and sometimes assigning to column to be another column's
+		// value, we just write the SQL directly.
+		global $wpdb;
+
+		$query = "
                 UPDATE {$wpdb->term_taxonomy} AS tt 
                 SET count = (
                     select count(*) as proper_count from {$wpdb->term_relationships} AS tr 
                     WHERE tt.term_taxonomy_id = tr.term_taxonomy_id
                 )";
 
-        if ($term_taxonomy_id) {
-            $query .= ' WHERE tt.term_taxonomy_id = %d';
-            $query = $wpdb->prepare(
-                $query,
-                $term_taxonomy_id
-            );
-        }
-        $rows_affected = $this->_do_wpdb_query(
-            'query',
-            array(
-                $query,
-            )
-        );
-        return $rows_affected;
-    }
-
-
-
-    /**
-     * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
-     * inserting
-     *
-     * @param array $field_n_values @see EEM_Base::insert
-     * @return boolean
-     */
-    public function insert($field_n_values)
-    {
-        $return = parent::insert($field_n_values);
-        if (isset($field_n_values['term_taxonomy_id'])) {
-            $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * Overrides parent so that after an update, we also check the term_taxonomy_counts are
-     * all ok
-     *
-     * @param array   $fields_n_values         see EEM_Base::update
-     * @param array   $query_params            @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Overrides parent so that after running this, we also double-check
-     * the term taxonomy counts are up-to-date
-     *
-     * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $allow_blocking
-     * @return int @see EEM_Base::delete
-     */
-    public function delete($query_params, $allow_blocking = true)
-    {
-        $count = parent::delete($query_params, $allow_blocking);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Makes sure that during REST API queries, we only return term relationships
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Relationship::instance()) {
-            $taxonomies = get_taxonomies(array('show_in_rest' => true));
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies);
-            }
-        }
-        return $model_query_params;
-    }
+		if ($term_taxonomy_id) {
+			$query .= ' WHERE tt.term_taxonomy_id = %d';
+			$query = $wpdb->prepare(
+				$query,
+				$term_taxonomy_id
+			);
+		}
+		$rows_affected = $this->_do_wpdb_query(
+			'query',
+			array(
+				$query,
+			)
+		);
+		return $rows_affected;
+	}
+
+
+
+	/**
+	 * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
+	 * inserting
+	 *
+	 * @param array $field_n_values @see EEM_Base::insert
+	 * @return boolean
+	 */
+	public function insert($field_n_values)
+	{
+		$return = parent::insert($field_n_values);
+		if (isset($field_n_values['term_taxonomy_id'])) {
+			$this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * Overrides parent so that after an update, we also check the term_taxonomy_counts are
+	 * all ok
+	 *
+	 * @param array   $fields_n_values         see EEM_Base::update
+	 * @param array   $query_params            @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Overrides parent so that after running this, we also double-check
+	 * the term taxonomy counts are up-to-date
+	 *
+	 * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $allow_blocking
+	 * @return int @see EEM_Base::delete
+	 */
+	public function delete($query_params, $allow_blocking = true)
+	{
+		$count = parent::delete($query_params, $allow_blocking);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Makes sure that during REST API queries, we only return term relationships
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Relationship::instance()) {
+			$taxonomies = get_taxonomies(array('show_in_rest' => true));
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies);
+			}
+		}
+		return $model_query_params;
+	}
 }

core/db_models/EEM_Checkin.model.php

Indentation +32 added lines, -32 removed lines

@@ -14,40 +14,40 @@
 class EEM_Checkin extends EEM_Base
 {
 
-    // private instance of the EEM_Checkin object
-    protected static $_instance = null;
+	// private instance of the EEM_Checkin object
+	protected static $_instance = null;
 
 
 
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @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)
-     *      @return void
-     */
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = __('Check-In', 'event_espresso');
-        $this->plural_item = __('Check-Ins', 'event_espresso');
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @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)
+	 *      @return void
+	 */
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = __('Check-In', 'event_espresso');
+		$this->plural_item = __('Check-Ins', 'event_espresso');
 
-        $this->_tables = array(
-            'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID')
-        );
-        $this->_fields = array(
-            'Checkin' => array(
-                'CHK_ID' => new EE_Primary_Key_Int_Field('CHK_ID', 'Check-in ID'),
-                'REG_ID' => new EE_Foreign_Key_Int_Field('REG_ID', 'Registration Id', false, 0, 'Registration'),
-                'DTT_ID' => new EE_Foreign_Key_Int_Field('DTT_ID', 'Datetime Id', false, 0, 'Datetime'),
-                'CHK_in' => new EE_Boolean_Field('CHK_in', 'Whether a person has checked in or checked out', false, true),
-                'CHK_timestamp' => new EE_Datetime_Field('CHK_timestamp', __('When the row was modified', 'event_espresso'), false, EE_Datetime_Field::now, $timezone)
-            )
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Datetime' => new EE_Belongs_To_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID')
+		);
+		$this->_fields = array(
+			'Checkin' => array(
+				'CHK_ID' => new EE_Primary_Key_Int_Field('CHK_ID', 'Check-in ID'),
+				'REG_ID' => new EE_Foreign_Key_Int_Field('REG_ID', 'Registration Id', false, 0, 'Registration'),
+				'DTT_ID' => new EE_Foreign_Key_Int_Field('DTT_ID', 'Datetime Id', false, 0, 'Datetime'),
+				'CHK_in' => new EE_Boolean_Field('CHK_in', 'Whether a person has checked in or checked out', false, true),
+				'CHK_timestamp' => new EE_Datetime_Field('CHK_timestamp', __('When the row was modified', 'event_espresso'), false, EE_Datetime_Field::now, $timezone)
+			)
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Datetime' => new EE_Belongs_To_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Currency_Payment_Method.model.php

Indentation +25 added lines, -25 removed lines

@@ -11,31 +11,31 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = __('Currency Usable by Payment Method', 'event_espresso');
-        $this->plural_item = __('Currencies Usable by Payment Methods', 'event_espresso');
-        $this->_tables = array(
-            'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
-        );
-        $this->_fields = array(
-            'Currency_Payment_Method' => array(
-                'CPM_ID' => new EE_Primary_Key_Int_Field('CPM_ID', __('Currency to Payment Method LInk ID', 'event_espresso')),
-                'CUR_code' => new EE_Foreign_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso'), false, '', 'Currency'),
-                'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', __('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
-            )
-        );
-        $this->_model_relations = array(
-            'Currency' => new EE_Belongs_To_Relation(),
-            'Payment_Method' => new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_caps_slug = 'payment_methods';
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = __('Currency Usable by Payment Method', 'event_espresso');
+		$this->plural_item = __('Currencies Usable by Payment Methods', 'event_espresso');
+		$this->_tables = array(
+			'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
+		);
+		$this->_fields = array(
+			'Currency_Payment_Method' => array(
+				'CPM_ID' => new EE_Primary_Key_Int_Field('CPM_ID', __('Currency to Payment Method LInk ID', 'event_espresso')),
+				'CUR_code' => new EE_Foreign_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso'), false, '', 'Currency'),
+				'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', __('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
+			)
+		);
+		$this->_model_relations = array(
+			'Currency' => new EE_Belongs_To_Relation(),
+			'Payment_Method' => new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_caps_slug = 'payment_methods';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Event.model.php

Indentation +912 added lines, -912 removed lines

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

core/db_models/EEM_Soft_Delete_Base.model.php

Indentation +361 added lines, -361 removed lines

@@ -27,365 +27,365 @@
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = '')
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(__(
-                'We are trying to find the deleted 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)));
-        }
-    }
-
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted_or_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'default')
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
-        return $query_params;
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted_and_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        if (! $ID) {
-            return false;
-        }
-        if (
-            $this->delete_or_restore(
-                $delete,
-                $this->alter_query_params_to_restrict_by_ID($ID)
-            )
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
-     * Note: because this item will be soft-deleted only,
-     * doesn't block because of model dependencies
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param bool  $block_deletes
-     * @return boolean
-     */
-    public function delete($query_params = array(), $block_deletes = false)
-    {
-        // no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
-     * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function restore($query_params = array())
-    {
-        return $this->delete_or_restore(false, $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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match $query_params. This
-     *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
-     *                                         be aware that model objects being used could get out-of-sync with the database
-     * @return int number of items updated
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = '')
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(__(
+				'We are trying to find the deleted 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)));
+		}
+	}
+
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted_or_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'default')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][ $deletedFlagFieldName ] = true;
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted_and_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+	 *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+	 * @return boolean success
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		if (! $ID) {
+			return false;
+		}
+		if (
+			$this->delete_or_restore(
+				$delete,
+				$this->alter_query_params_to_restrict_by_ID($ID)
+			)
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
+	 * Note: because this item will be soft-deleted only,
+	 * doesn't block because of model dependencies
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param bool  $block_deletes
+	 * @return boolean
+	 */
+	public function delete($query_params = array(), $block_deletes = false)
+	{
+		// no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
+	 * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function restore($query_params = array())
+	{
+		return $this->delete_or_restore(false, $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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match $query_params. This
+	 *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
+	 *                                         be aware that model objects being used could get out-of-sync with the database
+	 * @return int number of items updated
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -33,7 +33,7 @@ 
      */
     protected function __construct($timezone = '')
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -134,7 +134,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -174,7 +174,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;
@@ -302,7 +302,7 @@ 
      */
     public function delete_or_restore_by_ID($delete = true, $ID = false)
     {
-        if (! $ID) {
+        if ( ! $ID) {
             return false;
         }
         if (