eventespresso / event-espresso-core

core/db_models/EEM_Datetime.model.php

Indentation +847 added lines, -847 removed lines

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

Spacing +20 added lines, -20 removed lines

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

core/db_models/EEM_Registration.model.php

Indentation +873 added lines, -873 removed lines

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

Spacing +28 added lines, -28 removed lines

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

core/db_models/EEM_Transaction.model.php

Indentation +456 added lines, -456 removed lines

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

Spacing +12 added lines, -12 removed lines

@@ -136,7 +136,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -202,7 +202,7 @@ 
             ],
             OBJECT,
             [
-                'txnDate' => ['DATE(' . $query_interval . ')', '%s'],
+                'txnDate' => ['DATE('.$query_interval.')', '%s'],
                 'revenue' => ['SUM(TransactionTable.TXN_paid)', '%d'],
             ]
         );
@@ -218,11 +218,11 @@ 
     public function get_revenue_per_event_report(string $period = '-1 month'): array
     {
         global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $transaction_table          = $wpdb->prefix.'esp_transaction';
+        $registration_table         = $wpdb->prefix.'esp_registration';
+        $registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
+        $payment_table              = $wpdb->prefix.'esp_payment';
         $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status    = EEM_Payment::status_id_approved;
         $extra_event_on_join        = '';
@@ -233,7 +233,7 @@ 
                 'reg_per_event_report'
             )
         ) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
 
         return $wpdb->get_results(
@@ -313,7 +313,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, bool $save_txn = true): array
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -385,7 +385,7 @@ 
             $time_to_leave_alone
         );
         // now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
 
@@ -398,7 +398,7 @@ 
             // let's get deletin'...
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
+            $query   = $wpdb->prepare("DELETE FROM ".$this->table()." WHERE TXN_ID IN ( $format )", $txn_ids);
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {
@@ -422,8 +422,8 @@ 
         $locked_transactions = get_option('ee_locked_transactions', []);
         $update              = false;
         foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[ $TXN_ID ])) {
-                unset($locked_transactions[ $TXN_ID ]);
+            if (isset($locked_transactions[$TXN_ID])) {
+                unset($locked_transactions[$TXN_ID]);
                 $update = true;
             }
         }

core/db_models/EEM_Question_Option.model.php

Indentation +80 added lines, -80 removed lines

@@ -10,90 +10,90 @@
 class EEM_Question_Option extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Question_Option
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Question_Option
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Question_Option constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Option', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Options', 'event_espresso');
+	/**
+	 * EEM_Question_Option constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Option', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Options', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Option' => [
-                'QSO_ID'      => new EE_Primary_Key_Int_Field(
-                    'QSO_ID',
-                    esc_html__('Question Option ID', 'event_espresso')
-                ),
-                'QST_ID'      => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QSO_deleted' => new EE_Trashed_Flag_Field(
-                    'QSO_deleted',
-                    esc_html__('Flag indicating Option was trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_desc'    => new EE_Post_Content_Field(
-                    'QSO_desc',
-                    esc_html__('Question Option Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSO_order'   => new EE_Integer_Field(
-                    'QSO_order',
-                    esc_html__('Question Option Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QSO_system'  => new EE_Plain_Text_Field(
-                    'QSO_system',
-                    esc_html__('Internal string ID for question option', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'QSO_value'   => new EE_Plain_Text_Field(
-                    'QSO_value',
-                    esc_html__("Question Option Value", "event_espresso"),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question' => new EE_Belongs_To_Relation(),
-        ];
+		$this->_tables          = [
+			'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
+		];
+		$this->_fields          = [
+			'Question_Option' => [
+				'QSO_ID'      => new EE_Primary_Key_Int_Field(
+					'QSO_ID',
+					esc_html__('Question Option ID', 'event_espresso')
+				),
+				'QST_ID'      => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QSO_deleted' => new EE_Trashed_Flag_Field(
+					'QSO_deleted',
+					esc_html__('Flag indicating Option was trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_desc'    => new EE_Post_Content_Field(
+					'QSO_desc',
+					esc_html__('Question Option Description', 'event_espresso'),
+					false,
+					''
+				),
+				'QSO_order'   => new EE_Integer_Field(
+					'QSO_order',
+					esc_html__('Question Option Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QSO_system'  => new EE_Plain_Text_Field(
+					'QSO_system',
+					esc_html__('Internal string ID for question option', 'event_espresso'),
+					true,
+					null
+				),
+				'QSO_value'   => new EE_Plain_Text_Field(
+					'QSO_value',
+					esc_html__("Question Option Value", "event_espresso"),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question' => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_caps_slug              = 'questions';
-        $this->_model_chain_to_wp_user = 'Question';
+		$this->_caps_slug              = 'questions';
+		$this->_model_chain_to_wp_user = 'Question';
 
-        // 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(
-                'QSO_system'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form(
-                'QSO_system'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form(
-                'QSO_system'
-            );
+		// 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(
+				'QSO_system'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form(
+				'QSO_system'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form(
+				'QSO_system'
+			);
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -83,14 +83,14 @@
         $this->_model_chain_to_wp_user = 'Question';
 
         // 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(
+        $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(
                 'QSO_system'
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Reg_Form(
                 'QSO_system'
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Reg_Form(
                 'QSO_system'
             );
 

core/db_models/EEM_Question_Group.model.php

Indentation +136 added lines, -136 removed lines

@@ -9,148 +9,148 @@
  */
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
-    /**
-     * personal information question group identifier
-     *
-     * @const int
-     */
-    const system_personal = 1;
+	/**
+	 * personal information question group identifier
+	 *
+	 * @const int
+	 */
+	const system_personal = 1;
 
-    /**
-     * address information question group identifier
-     *
-     * @const int
-     */
-    const system_address = 2;
+	/**
+	 * address information question group identifier
+	 *
+	 * @const int
+	 */
+	const system_address = 2;
 
-    /**
-     * private instance of the EEM_Question_Group object
-     *
-     * @var EEM_Question_Group
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_Question_Group object
+	 *
+	 * @var EEM_Question_Group
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Question_Group constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $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 $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $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
-     * @throws ReflectionException
-     */
-    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
+	 * @throws ReflectionException
+	 */
+	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_Term_Relationship.model.php

Indentation +236 added lines, -236 removed lines

@@ -10,246 +10,246 @@
 class EEM_Term_Relationship extends EEM_Base
 {
 
-    /**
-     * @var EEM_Term_Relationship
-     */
-    protected static $_instance;
-
-
-    /**
-     * EEM_Term_Relationship constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
-        $this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
-        $this->_tables             = [
-            'Term_Relationship' => new EE_Primary_Table('term_relationships'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields             = [
-            'Term_Relationship' => [
-                'object_id'        => new EE_Foreign_Key_Int_Field(
-                    'object_id',
-                    esc_html__('Object(Post) ID', 'event_espresso'),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
-                    'term_taxonomy_id',
-                    esc_html__(
-                        'Term (in context of a taxonomy) ID',
-                        'event_espresso'
-                    ),
-                    false,
-                    0,
-                    'Term_Taxonomy'
-                ),
-                'term_order'       => new EE_Integer_Field(
-                    'term_order',
-                    esc_html__('Term Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            '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       = [
-            'PRIMARY' => new EE_Primary_Key_Index(['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 = [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(
-                [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
-                        '!=',
-                        'espresso_event_categories',
-                    ],
-                ]
-            );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category']
-                = new EE_Default_Where_Conditions(
-                [
-                    $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
-                        '!=',
-                        'espresso_venue_categories',
-                    ],
-                ]
-            );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']
-                = new EE_Default_Where_Conditions(
-                [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
-                ]
-            );
-        }
-        parent::__construct($timezone);
-        add_filter(
-            'FHEE__Read__create_model_query_params',
-            ['EEM_Term_Relationship', 'rest_api_query_params'],
-            10,
-            3
-        );
-    }
-
-
-    /**
-     * Makes sure all term-taxonomy counts are correct
-     *
-     * @param int|null $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
-     * @return int the number of rows affected
-     * @throws EE_Error
-     * @global wpdb    $wpdb
-     */
-    public function update_term_taxonomy_counts(int $term_taxonomy_id = 0): int
-    {
-        // 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 = "
+	/**
+	 * @var EEM_Term_Relationship
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * EEM_Term_Relationship constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item       = esc_html__('Term Relationship', 'event_espresso');
+		$this->plural_item         = esc_html__('Term Relationships', 'event_espresso');
+		$this->_tables             = [
+			'Term_Relationship' => new EE_Primary_Table('term_relationships'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields             = [
+			'Term_Relationship' => [
+				'object_id'        => new EE_Foreign_Key_Int_Field(
+					'object_id',
+					esc_html__('Object(Post) ID', 'event_espresso'),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
+					'term_taxonomy_id',
+					esc_html__(
+						'Term (in context of a taxonomy) ID',
+						'event_espresso'
+					),
+					false,
+					0,
+					'Term_Taxonomy'
+				),
+				'term_order'       => new EE_Integer_Field(
+					'term_order',
+					esc_html__('Term Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'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       = [
+			'PRIMARY' => new EE_Primary_Key_Index(['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 = [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(
+				[
+					$path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+						'!=',
+						'espresso_event_categories',
+					],
+				]
+			);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category']
+				= new EE_Default_Where_Conditions(
+				[
+					$path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+						'!=',
+						'espresso_venue_categories',
+					],
+				]
+			);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']
+				= new EE_Default_Where_Conditions(
+				[
+					$path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+				]
+			);
+		}
+		parent::__construct($timezone);
+		add_filter(
+			'FHEE__Read__create_model_query_params',
+			['EEM_Term_Relationship', 'rest_api_query_params'],
+			10,
+			3
+		);
+	}
+
+
+	/**
+	 * Makes sure all term-taxonomy counts are correct
+	 *
+	 * @param int|null $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+	 * @return int the number of rows affected
+	 * @throws EE_Error
+	 * @global wpdb    $wpdb
+	 */
+	public function update_term_taxonomy_counts(int $term_taxonomy_id = 0): int
+	{
+		// 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
-            );
-        }
-        return $this->_do_wpdb_query(
-            'query',
-            [
-                $query,
-            ]
-        );
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function insert($field_n_values): bool
-    {
-        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true): int
-    {
-        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete($query_params, $allow_blocking = true): int
-    {
-        $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
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function rest_api_query_params(
-        array $model_query_params,
-        array $querystring_query_params,
-        EEM_Base $model
-    ): array {
-        if ($model === EEM_Term_Relationship::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+		if ($term_taxonomy_id) {
+			$query .= ' WHERE tt.term_taxonomy_id = %d';
+			$query = $wpdb->prepare(
+				$query,
+				$term_taxonomy_id
+			);
+		}
+		return $this->_do_wpdb_query(
+			'query',
+			[
+				$query,
+			]
+		);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function insert($field_n_values): bool
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true): int
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete($query_params, $allow_blocking = true): int
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function rest_api_query_params(
+		array $model_query_params,
+		array $querystring_query_params,
+		EEM_Base $model
+	): array {
+		if ($model === EEM_Term_Relationship::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -57,61 +57,61 @@ 
                 ),
             ],
         ];
-        $this->_model_relations    = [
+        $this->_model_relations = [
             '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->_model_relations[$model_name] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         $this->_indexes       = [
             'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
         ];
         $path_to_event_model  = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read]
                               = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
         );
-        $path_to_tax_model    = 'Term_Taxonomy.';
+        $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 = [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']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_category']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+                    $path_to_tax_model.'taxonomy*ee_assign_event_category' => [
                         '!=',
                         'espresso_event_categories',
                     ],
                 ]
             );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_venue_category']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+                    $path_to_tax_model.'taxonomy*ee_assign_venue_category' => [
                         '!=',
                         'espresso_venue_categories',
                     ],
                 ]
             );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_type']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+                    $path_to_tax_model.'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
                 ]
             );
         }
@@ -246,7 +246,7 @@ 
     ): array {
         if ($model === EEM_Term_Relationship::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/EEM_Registration_Payment.model.php

Indentation +51 added lines, -51 removed lines

@@ -14,62 +14,62 @@
 class EEM_Registration_Payment extends EEM_Base
 {
 
-    /**
-     * @var EEM_Registration_Payment
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Registration_Payment
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Registration_Payment constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
+	/**
+	 * EEM_Registration_Payment constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
 
-        $this->singular_item = esc_html__('Registration Payment', 'event_espresso');
-        $this->plural_item   = esc_html__('Registration Payments', 'event_espresso');
+		$this->singular_item = esc_html__('Registration Payment', 'event_espresso');
+		$this->plural_item   = esc_html__('Registration Payments', 'event_espresso');
 
-        $this->_tables = [
-            'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID'),
-        ];
+		$this->_tables = [
+			'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID'),
+		];
 
-        $this->_fields = [
-            'Registration_Payment' => [
-                'RPY_ID'     => new EE_Primary_Key_Int_Field(
-                    'RPY_ID',
-                    esc_html__('Registration Payment ID', 'event_espresso')
-                ),
-                'REG_ID'     => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'PAY_ID'     => new EE_Foreign_Key_Int_Field(
-                    'PAY_ID',
-                    esc_html__('Payment ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Payment'
-                ),
-                'RPY_amount' => new EE_Money_Field(
-                    'RPY_amount',
-                    esc_html__('Amount attributed to the registration', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
+		$this->_fields = [
+			'Registration_Payment' => [
+				'RPY_ID'     => new EE_Primary_Key_Int_Field(
+					'RPY_ID',
+					esc_html__('Registration Payment ID', 'event_espresso')
+				),
+				'REG_ID'     => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'PAY_ID'     => new EE_Foreign_Key_Int_Field(
+					'PAY_ID',
+					esc_html__('Payment ID', 'event_espresso'),
+					true,
+					null,
+					'Payment'
+				),
+				'RPY_amount' => new EE_Money_Field(
+					'RPY_amount',
+					esc_html__('Amount attributed to the registration', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
 
-        $this->_model_relations = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Payment'      => new EE_Belongs_To_Relation(),
-        ];
+		$this->_model_relations = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Payment'      => new EE_Belongs_To_Relation(),
+		];
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Event.model.php

Indentation +948 added lines, -948 removed lines

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

Spacing +22 added lines, -22 removed lines

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

core/db_models/EEM_Soft_Delete_Base.model.php

Indentation +398 added lines, -398 removed lines

@@ -27,402 +27,402 @@
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $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(
-                    esc_html__(
-                        '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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_deleted(array $query_params = []): EE_Soft_Delete_Base_Class
-    {
-        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_deleted_or_undeleted(array $query_params = []): EE_Soft_Delete_Base_Class
-    {
-        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_by_ID_but_ignore_deleted($id): EE_Soft_Delete_Base_Class
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                ['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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_deleted(array $query_params = [], string $field_to_count = '', bool $distinct = false): int
-    {
-        $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
-     * @throws EE_Error
-     */
-    protected function _alter_query_params_so_only_trashed_items_included(array $query_params): array
-    {
-        $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
-     * @throws EE_Error
-     */
-    public function alter_query_params_so_only_trashed_items_included(array $query_params): array
-    {
-        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(array $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(array $query_params): array
-    {
-        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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_deleted_and_undeleted(
-        array $query_params = [],
-        string $field_to_count = '',
-        bool $distinct = false
-    ): int {
-        $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 null  $field_to_sum
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_deleted(array $query_params = [], $field_to_sum = null): float
-    {
-        $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 null  $field_to_sum
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_deleted_and_undeleted(array $query_params = [], $field_to_sum = null): float
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return 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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_deleted_and_undeleted(array $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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_deleted(array $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently($query_params = [], $allow_blocking = true): bool
-    {
-        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_by_ID($ID = false): bool
-    {
-        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 int|string $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_or_restore_by_ID(bool $delete = true, $ID = 0): bool
-    {
-        if (empty($ID)) {
-            return false;
-        }
-        return $this->delete_or_restore(
-            $delete,
-            $this->alter_query_params_to_restrict_by_ID($ID)
-        );
-    }
-
-
-    /**
-     * 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  $allow_blocking
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete($query_params = [], $allow_blocking = false): bool
-    {
-        // 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore(array $query_params = []): bool
-    {
-        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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_or_restore(bool $delete = true, array $query_params = []): bool
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params         = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update([$deletedFlagFieldName => $delete], $query_params);
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_deleted_and_undeleted(
-        array $fields_n_values,
-        array $query_params,
-        bool $keep_model_objs_in_sync = true
-    ): int {
-        $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(string $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(
+					esc_html__(
+						'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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_deleted(array $query_params = []): EE_Soft_Delete_Base_Class
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_deleted_or_undeleted(array $query_params = []): EE_Soft_Delete_Base_Class
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id): EE_Soft_Delete_Base_Class
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				['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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_deleted(array $query_params = [], string $field_to_count = '', bool $distinct = false): int
+	{
+		$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
+	 * @throws EE_Error
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included(array $query_params): array
+	{
+		$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
+	 * @throws EE_Error
+	 */
+	public function alter_query_params_so_only_trashed_items_included(array $query_params): array
+	{
+		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(array $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(array $query_params): array
+	{
+		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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_deleted_and_undeleted(
+		array $query_params = [],
+		string $field_to_count = '',
+		bool $distinct = false
+	): int {
+		$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 null  $field_to_sum
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_deleted(array $query_params = [], $field_to_sum = null): float
+	{
+		$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 null  $field_to_sum
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_deleted_and_undeleted(array $query_params = [], $field_to_sum = null): float
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return 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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_deleted_and_undeleted(array $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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_deleted(array $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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently($query_params = [], $allow_blocking = true): bool
+	{
+		$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_by_ID($ID = false): bool
+	{
+		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 int|string $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_or_restore_by_ID(bool $delete = true, $ID = 0): bool
+	{
+		if (empty($ID)) {
+			return false;
+		}
+		return $this->delete_or_restore(
+			$delete,
+			$this->alter_query_params_to_restrict_by_ID($ID)
+		);
+	}
+
+
+	/**
+	 * 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  $allow_blocking
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete($query_params = [], $allow_blocking = false): bool
+	{
+		// 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore(array $query_params = []): bool
+	{
+		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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_or_restore(bool $delete = true, array $query_params = []): bool
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params         = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update([$deletedFlagFieldName => $delete], $query_params);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_deleted_and_undeleted(
+		array $fields_n_values,
+		array $query_params,
+		bool $keep_model_objs_in_sync = true
+	): int {
+		$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 +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      */
     protected function __construct(string $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);
@@ -148,7 +148,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included(array $query_params): array
     {
         $deletedFlagFieldName                     = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -188,7 +188,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included(array $query_params): array
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;