eventespresso / event-espresso-core

core/db_models/EEM_Registration.model.php

Indentation +863 added lines, -863 removed lines

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

@@ -191,7 +191,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(),
@@ -322,7 +322,7 @@ 
             EEM_Registration::instance()->_get_registration_status_array($exclude);
         } elseif ($exclude) {
             foreach ($exclude as $excluded_status) {
-                unset(self::$_reg_status[ $excluded_status ]);
+                unset(self::$_reg_status[$excluded_status]);
             }
         }
         return $translated
@@ -346,14 +346,14 @@ 
         // and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results           = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
             self::$_reg_status = [];
             foreach ($results as $status) {
-                if (! in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+                if ( ! in_array($status->STS_ID, $exclude, true)) {
+                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
                 }
             }
         }
@@ -417,7 +417,7 @@ 
      */
     public function get_all_registrations_for_attendee(int $ATT_ID = 0): ?array
     {
-        if (! $ATT_ID) {
+        if ( ! $ATT_ID) {
             return null;
         }
         return $this->get_all([['ATT_ID' => $ATT_ID]]);
@@ -434,7 +434,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]]);
@@ -483,11 +483,11 @@ 
             'Y-m-d H:i:s',
             'UTC'
         );
-        $where    = [
+        $where = [
             'REG_date' => ['>=', $sql_date],
             'STS_ID'   => ['!=', RegStatus::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');
@@ -499,7 +499,7 @@ 
             ],
             OBJECT,
             [
-                'regDate' => ['DATE(' . $query_interval . ')', '%s'],
+                'regDate' => ['DATE('.$query_interval.')', '%s'],
                 'total'   => ['count(REG_ID)', '%d'],
             ]
         );
@@ -519,7 +519,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
@@ -528,9 +528,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;
@@ -554,7 +554,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);
     }
@@ -576,7 +576,7 @@ 
             'Y-m-d H:i:s',
             'UTC'
         );
-        $where    = [
+        $where = [
             'REG_date' => ['>=', $date_sql],
             'STS_ID'   => ['!=', RegStatus::INCOMPLETE],
         ];
@@ -617,16 +617,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;
@@ -650,7 +650,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);
     }
@@ -665,7 +665,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(
@@ -740,11 +740,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 '
@@ -777,12 +777,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'
@@ -812,7 +812,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)
@@ -834,7 +834,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 [];
         }
@@ -866,7 +866,7 @@ 
     public function event_reg_count_for_statuses(int $EVT_ID, $statuses = []): int
     {
         $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             throw new InvalidArgumentException(
                 esc_html__('An invalid Event ID was supplied.', 'event_espresso')
             );
@@ -876,7 +876,7 @@ 
 
         $valid_reg_statuses = EEM_Registration::reg_statuses();
         foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
+            if ( ! in_array($status, $valid_reg_statuses, true)) {
                 throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
             }
         }

core/db_models/EEM_Status.model.php

Indentation +293 added lines, -293 removed lines

@@ -12,308 +12,308 @@
  */
 class EEM_Status extends EEM_Base
 {
-    protected static ?EEM_Status $_instance = null;
+	protected static ?EEM_Status $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Status', 'event_espresso');
-        $this->plural_item      = esc_html__('Stati', 'event_espresso');
-        $this->_tables          = [
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        ];
-        $this->_fields          = [
-            'StatusTable' => [
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field(
-                    'STS_code', esc_html__('Status Code', 'event_espresso'), false, ''
-                ),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    esc_html__("Type", "event_espresso"),
-                    false,
-                    'event',
-                    [
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
-                        'registration' => esc_html__("Registration", "event_espresso"),
-                        'transaction'  => esc_html__("Transaction", "event_espresso"),
-                        'payment'      => esc_html__("Payment", "event_espresso"),
-                        'email'        => esc_html__("Email", "event_espresso"),
-                        'message'      => esc_html__("Message", "event_espresso"),
-                    ]
-                ),
-                'STS_can_edit' => new EE_Boolean_Field(
-                    'STS_can_edit',
-                    esc_html__('Editable?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'STS_desc'     => new EE_Simple_HTML_Field(
-                    'STS_desc',
-                    esc_html__("Description", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
-            ],
-        ];
-        $this->_model_relations = [
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => new EE_Has_Many_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Status', 'event_espresso');
+		$this->plural_item      = esc_html__('Stati', 'event_espresso');
+		$this->_tables          = [
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		];
+		$this->_fields          = [
+			'StatusTable' => [
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field(
+					'STS_code', esc_html__('Status Code', 'event_espresso'), false, ''
+				),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					esc_html__("Type", "event_espresso"),
+					false,
+					'event',
+					[
+						'event'        => esc_html__("Event", "event_espresso"),// deprecated
+						'registration' => esc_html__("Registration", "event_espresso"),
+						'transaction'  => esc_html__("Transaction", "event_espresso"),
+						'payment'      => esc_html__("Payment", "event_espresso"),
+						'email'        => esc_html__("Email", "event_espresso"),
+						'message'      => esc_html__("Message", "event_espresso"),
+					]
+				),
+				'STS_can_edit' => new EE_Boolean_Field(
+					'STS_can_edit',
+					esc_html__('Editable?', 'event_espresso'),
+					false,
+					false
+				),
+				'STS_desc'     => new EE_Simple_HTML_Field(
+					'STS_desc',
+					esc_html__("Description", "event_espresso"),
+					false,
+					''
+				),
+				'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
+			],
+		];
+		$this->_model_relations = [
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => new EE_Has_Many_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param array   $statuses  This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param boolean $plural    Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param string  $schema    This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @return array             an array of translated strings for the incoming status id.
-     * @throws EE_Error
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        // note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = [
-            RegStatus::PENDING_PAYMENT => [
-                esc_html__('pending payment', 'event_espresso'), // singular
-                esc_html__('pending payments', 'event_espresso'), // plural
-            ],
-            RegStatus::APPROVED        => [
-                esc_html__('approved', 'event_espresso'), // singular
-                esc_html__('approved', 'event_espresso'), // plural
-            ],
-            RegStatus::AWAITING_REVIEW    => [
-                esc_html__('not approved / awaiting review', 'event_espresso'),
-                esc_html__('not approved / awaiting review', 'event_espresso'),
-            ],
-            RegStatus::CANCELLED       => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            RegStatus::INCOMPLETE      => [
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ],
-            RegStatus::DECLINED        => [
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ],
-            RegStatus::WAIT_LIST       => [
-                esc_html__('wait list', 'event_espresso'),
-                esc_html__('wait list', 'event_espresso'),
-            ],
-            EEM_Transaction::overpaid_status_code       => [
-                esc_html__('overpaid', 'event_espresso'),
-                esc_html__('overpaid', 'event_espresso'),
-            ],
-            EEM_Transaction::complete_status_code       => [
-                esc_html__('complete', 'event_espresso'),
-                esc_html__('complete', 'event_espresso'),
-            ],
-            EEM_Transaction::incomplete_status_code     => [
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ],
-            EEM_Transaction::failed_status_code         => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            EEM_Transaction::abandoned_status_code      => [
-                esc_html__('abandoned', 'event_espresso'),
-                esc_html__('abandoned', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_approved             => [
-                esc_html__('accepted', 'event_espresso'),
-                esc_html__('accepted', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_pending              => [
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_cancelled            => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_declined             => [
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_failed               => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            // following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EEM_Event::postponed                        => [
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('Postponed', 'event_espresso'),
-            ],
-            EEM_Event::cancelled                        => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EE_Ticket::archived                         => [
-                esc_html__('archived', 'event_espresso'),
-                esc_html__('archived', 'event_espresso'),
-            ],
-            EE_Ticket::expired                          => [
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ],
-            EE_Ticket::sold_out                         => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EE_Ticket::pending                          => [
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ],
-            EE_Ticket::onsale                           => [
-                esc_html__('on sale', 'event_espresso'),
-                esc_html__('on sale', 'event_espresso'),
-            ],
-            EE_Datetime::cancelled                      => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EE_Datetime::sold_out                       => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EE_Datetime::expired                        => [
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ],
-            EE_Datetime::inactive                       => [
-                esc_html__('inactive', 'event_espresso'),
-                esc_html__('inactive', 'event_espresso'),
-            ],
-            EE_Datetime::upcoming                       => [
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ],
-            EE_Datetime::active                         => [
-                esc_html__('active', 'event_espresso'),
-                esc_html__('active', 'event_espresso'),
-            ],
-            EE_Datetime::postponed                      => [
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('postponed', 'event_espresso'),
-            ],
-            // messages related
-            EEM_Message::status_sent                    => [
-                esc_html__('sent', 'event_espresso'),
-                esc_html__('sent', 'event_espresso'),
-            ],
-            EEM_Message::status_idle                    => [
-                esc_html__('queued for sending', 'event_espresso'),
-                esc_html__('queued for sending', 'event_espresso'),
-            ],
-            EEM_Message::status_failed                  => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            EEM_Message::status_debug_only              => [
-                esc_html__('debug only', 'event_espresso'),
-                esc_html__('debug only', 'event_espresso'),
-            ],
-            EEM_Message::status_messenger_executing     => [
-                esc_html__('messenger is executing', 'event_espresso'),
-                esc_html__('messenger is executing', 'event_espresso'),
-            ],
-            EEM_Message::status_resend                  => [
-                esc_html__('queued for resending', 'event_espresso'),
-                esc_html__('queued for resending', 'event_espresso'),
-            ],
-            EEM_Message::status_incomplete              => [
-                esc_html__('queued for generating', 'event_espresso'),
-                esc_html__('queued for generating', 'event_espresso'),
-            ],
-            EEM_Message::status_retry                   => [
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_publish           => [
-                esc_html__('published', 'event_espresso'),
-                esc_html__('published', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_future            => [
-                esc_html__('scheduled', 'event_espresso'),
-                esc_html__('scheduled', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_draft             => [
-                esc_html__('draft', 'event_espresso'),
-                esc_html__('draft', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_pending           => [
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_private           => [
-                esc_html__('private', 'event_espresso'),
-                esc_html__('private', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_trashed           => [
-                esc_html__('trashed', 'event_espresso'),
-                esc_html__('trashed', 'event_espresso'),
-            ],
-        ];
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param array   $statuses  This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param boolean $plural    Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param string  $schema    This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @return array             an array of translated strings for the incoming status id.
+	 * @throws EE_Error
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		// note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = [
+			RegStatus::PENDING_PAYMENT => [
+				esc_html__('pending payment', 'event_espresso'), // singular
+				esc_html__('pending payments', 'event_espresso'), // plural
+			],
+			RegStatus::APPROVED        => [
+				esc_html__('approved', 'event_espresso'), // singular
+				esc_html__('approved', 'event_espresso'), // plural
+			],
+			RegStatus::AWAITING_REVIEW    => [
+				esc_html__('not approved / awaiting review', 'event_espresso'),
+				esc_html__('not approved / awaiting review', 'event_espresso'),
+			],
+			RegStatus::CANCELLED       => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			RegStatus::INCOMPLETE      => [
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			],
+			RegStatus::DECLINED        => [
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			],
+			RegStatus::WAIT_LIST       => [
+				esc_html__('wait list', 'event_espresso'),
+				esc_html__('wait list', 'event_espresso'),
+			],
+			EEM_Transaction::overpaid_status_code       => [
+				esc_html__('overpaid', 'event_espresso'),
+				esc_html__('overpaid', 'event_espresso'),
+			],
+			EEM_Transaction::complete_status_code       => [
+				esc_html__('complete', 'event_espresso'),
+				esc_html__('complete', 'event_espresso'),
+			],
+			EEM_Transaction::incomplete_status_code     => [
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			],
+			EEM_Transaction::failed_status_code         => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			EEM_Transaction::abandoned_status_code      => [
+				esc_html__('abandoned', 'event_espresso'),
+				esc_html__('abandoned', 'event_espresso'),
+			],
+			EEM_Payment::status_id_approved             => [
+				esc_html__('accepted', 'event_espresso'),
+				esc_html__('accepted', 'event_espresso'),
+			],
+			EEM_Payment::status_id_pending              => [
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			],
+			EEM_Payment::status_id_cancelled            => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EEM_Payment::status_id_declined             => [
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			],
+			EEM_Payment::status_id_failed               => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			// following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EEM_Event::postponed                        => [
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('Postponed', 'event_espresso'),
+			],
+			EEM_Event::cancelled                        => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EE_Ticket::archived                         => [
+				esc_html__('archived', 'event_espresso'),
+				esc_html__('archived', 'event_espresso'),
+			],
+			EE_Ticket::expired                          => [
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			],
+			EE_Ticket::sold_out                         => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EE_Ticket::pending                          => [
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			],
+			EE_Ticket::onsale                           => [
+				esc_html__('on sale', 'event_espresso'),
+				esc_html__('on sale', 'event_espresso'),
+			],
+			EE_Datetime::cancelled                      => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EE_Datetime::sold_out                       => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EE_Datetime::expired                        => [
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			],
+			EE_Datetime::inactive                       => [
+				esc_html__('inactive', 'event_espresso'),
+				esc_html__('inactive', 'event_espresso'),
+			],
+			EE_Datetime::upcoming                       => [
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			],
+			EE_Datetime::active                         => [
+				esc_html__('active', 'event_espresso'),
+				esc_html__('active', 'event_espresso'),
+			],
+			EE_Datetime::postponed                      => [
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('postponed', 'event_espresso'),
+			],
+			// messages related
+			EEM_Message::status_sent                    => [
+				esc_html__('sent', 'event_espresso'),
+				esc_html__('sent', 'event_espresso'),
+			],
+			EEM_Message::status_idle                    => [
+				esc_html__('queued for sending', 'event_espresso'),
+				esc_html__('queued for sending', 'event_espresso'),
+			],
+			EEM_Message::status_failed                  => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			EEM_Message::status_debug_only              => [
+				esc_html__('debug only', 'event_espresso'),
+				esc_html__('debug only', 'event_espresso'),
+			],
+			EEM_Message::status_messenger_executing     => [
+				esc_html__('messenger is executing', 'event_espresso'),
+				esc_html__('messenger is executing', 'event_espresso'),
+			],
+			EEM_Message::status_resend                  => [
+				esc_html__('queued for resending', 'event_espresso'),
+				esc_html__('queued for resending', 'event_espresso'),
+			],
+			EEM_Message::status_incomplete              => [
+				esc_html__('queued for generating', 'event_espresso'),
+				esc_html__('queued for generating', 'event_espresso'),
+			],
+			EEM_Message::status_retry                   => [
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_publish           => [
+				esc_html__('published', 'event_espresso'),
+				esc_html__('published', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_future            => [
+				esc_html__('scheduled', 'event_espresso'),
+				esc_html__('scheduled', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_draft             => [
+				esc_html__('draft', 'event_espresso'),
+				esc_html__('draft', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_pending           => [
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_private           => [
+				esc_html__('private', 'event_espresso'),
+				esc_html__('private', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_trashed           => [
+				esc_html__('trashed', 'event_espresso'),
+				esc_html__('trashed', 'event_espresso'),
+			],
+		];
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
-            throw new EE_Error(
-                esc_html__(
-                    'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($statuses)) {
+			throw new EE_Error(
+				esc_html__(
+					'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+					'event_espresso'
+				)
+			);
+		}
 
-        $translation = [];
+		$translation = [];
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
-            } else {
-                $translation[ $id ] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[ $id ])) {
+				$translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+			} else {
+				$translation[ $id ] = $code;
+			}
 
-            // schema
-            switch ($schema) {
-                case 'lower':
-                    $translation[ $id ] = strtolower(
-                        $translation[ $id ]
-                    ); // even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
-                    break;
-                case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
-                    break;
-            }
-        }
+			// schema
+			switch ($schema) {
+				case 'lower':
+					$translation[ $id ] = strtolower(
+						$translation[ $id ]
+					); // even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence':
+					$translation[ $id ] = ucwords($translation[ $id ]);
+					break;
+				case 'upper':
+					$translation[ $id ] = strtoupper($translation[ $id ]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 }

core/db_models/EEM_Event.model.php

Indentation +949 added lines, -949 removed lines

@@ -15,953 +15,953 @@
  */
 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';
-
-
-    protected static string $_default_reg_status;
-
-    protected static int $_default_additional_limit = 10;
-
-    protected static ?EEM_Event $_instance = null;
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string|null $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)
-            ? RegStatus::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(EspressoPostType::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
-                ),
-                'VNU_ID'                          => new EE_Foreign_Key_Int_Field(
-                    'VNU_ID',
-                    __('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                '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'),
-                    false,
-                    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
-                ),
-                'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
-                    true,
-                    null,
-                    'Form_Section',
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Form_Section'           => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Venue'                  => new EE_Belongs_To_Relation(),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password                            = '';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @param string $default_reg_status
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     *
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                false,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     *
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                ['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($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($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $query_params = [
-            [
-                'EVT_ID'                                                                         => $EVT_ID,
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
-            ],
-        ];
-        if ($for_primary_attendee) {
-            $query_params[0]['EQG_primary'] = true;
-        } else {
-            $query_params[0]['EQG_additional'] = true;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
-    {
-        if (! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID' => $EVT_ID,
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                        $registration->is_primary_registrant()
-                    )                             => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            [
-                [
-                    '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($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($query_params, $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']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // 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'),
-            ];
-        }
-        $where_params = $this->set_where_conditions_for_end_datetime($where_params);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // 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'),
-            ];
-        }
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // add where params for DTT_EVT_end
-        $where_params = $this->set_where_conditions_for_end_datetime($where_params);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0])
-            ? $query_params[0]
-            : [];
-        // 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']);
-        }
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->get_all_not_expired_event_ids($query_params);
-        // 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);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return int[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_not_expired_event_ids(array $query_params = []): array
-    {
-        $query_params[0] = [
-            'Datetime.DTT_EVT_end' => [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ],
-        ];
-        $event_ids       = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
-        return array_keys($event_ids);
-    }
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param array   $query_params  An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param boolean $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0])
-            ? $query_params[0]
-            : [];
-        // 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']);
-        }
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
-    {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-    /**
-     * @param array $where_params
-     * @return array
-     */
-    public function set_where_conditions_for_status(array $where_params): array
-    {
-        // 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 where 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];
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_where_conditions_for_end_datetime(array $where_params): array
-    {
-        $end_date_field_name = isset($where_params['Datetime.DTT_EVT_end'])
-            ? 'Datetime.DTT_EVT_end*****'
-            // prevents overwrite of existing where condition
-            : 'Datetime.DTT_EVT_end';
-
-        $where_params[ $end_date_field_name ] = [
-            '>',
-            EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-        ];
-
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param array $where_params
-     * @param bool  $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_count_or_all(array $query_params, array $where_params, bool $count = false)
-    {
-        $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);
-    }
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @param EE_Registration $registration    (so existing answers for registration are included)
-     * @param int             $EVT_ID          so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @return    array
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *                                         EE_Registration_Custom_Questions_Form located in
-     *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(
-                esc_html__(
-                    '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
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts                                    = $qg->questions();
-                $questions[ $qg->ID() ]                  = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = [];
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer                                                                   =
-                        EEM_Answer::instance()->get_one(
-                            [
-                                [
-                                    'QST_ID' => $qst->ID(),
-                                    'REG_ID' => $registration->ID(),
-                                ],
-                            ]
-                        );
-                    $answer                                                                   =
-                        $answer instanceof EE_Answer
-                            ? $answer
-                            : EEM_Answer::instance()->create_default_object();
-                    $qst_name                                                                 = $qstn_id = $qst->ID();
-                    $ans_id                                                                   = $answer->ID();
-                    $qst_name                                                                 = ! empty($ans_id)
-                        ? '[' . $qst_name . '][' . $ans_id . ']'
-                        : '[' . $qst_name . ']';
-                    $input_name                                                               = '';
-                    $input_id                                                                 =
-                        sanitize_key($qst->display_text());
-                    $input_class                                                              = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]                    =
-                        $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name']  = 'qstn'
-                                                                                                . $input_name
-                                                                                                . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id']    =
-                        $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options']     = [];
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj']         = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj']         = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] =
-                                    $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	protected static string $_default_reg_status;
+
+	protected static int $_default_additional_limit = 10;
+
+	protected static ?EEM_Event $_instance = null;
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string|null $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)
+			? RegStatus::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(EspressoPostType::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
+				),
+				'VNU_ID'                          => new EE_Foreign_Key_Int_Field(
+					'VNU_ID',
+					__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'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'),
+					false,
+					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
+				),
+				'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
+					true,
+					null,
+					'Form_Section',
+					false
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Form_Section'           => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Venue'                  => new EE_Belongs_To_Relation(),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password                            = '';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @param string $default_reg_status
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 *
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				false,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 *
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				['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($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($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$query_params = [
+			[
+				'EVT_ID'                                                                         => $EVT_ID,
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
+			],
+		];
+		if ($for_primary_attendee) {
+			$query_params[0]['EQG_primary'] = true;
+		} else {
+			$query_params[0]['EQG_additional'] = true;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
+	{
+		if (! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID' => $EVT_ID,
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext(
+						$registration->is_primary_registrant()
+					)                             => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			[
+				[
+					'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($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($query_params, $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']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// 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'),
+			];
+		}
+		$where_params = $this->set_where_conditions_for_end_datetime($where_params);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// 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'),
+			];
+		}
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// add where params for DTT_EVT_end
+		$where_params = $this->set_where_conditions_for_end_datetime($where_params);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0])
+			? $query_params[0]
+			: [];
+		// 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']);
+		}
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->get_all_not_expired_event_ids($query_params);
+		// 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);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return int[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_not_expired_event_ids(array $query_params = []): array
+	{
+		$query_params[0] = [
+			'Datetime.DTT_EVT_end' => [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			],
+		];
+		$event_ids       = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
+		return array_keys($event_ids);
+	}
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param array   $query_params  An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param boolean $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0])
+			? $query_params[0]
+			: [];
+		// 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']);
+		}
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
+	{
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @return array
+	 */
+	public function set_where_conditions_for_status(array $where_params): array
+	{
+		// 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 where 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];
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_where_conditions_for_end_datetime(array $where_params): array
+	{
+		$end_date_field_name = isset($where_params['Datetime.DTT_EVT_end'])
+			? 'Datetime.DTT_EVT_end*****'
+			// prevents overwrite of existing where condition
+			: 'Datetime.DTT_EVT_end';
+
+		$where_params[ $end_date_field_name ] = [
+			'>',
+			EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+		];
+
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param array $where_params
+	 * @param bool  $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_count_or_all(array $query_params, array $where_params, bool $count = false)
+	{
+		$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);
+	}
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @param EE_Registration $registration    (so existing answers for registration are included)
+	 * @param int             $EVT_ID          so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @return    array
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *                                         EE_Registration_Custom_Questions_Form located in
+	 *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(
+				esc_html__(
+					'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
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts                                    = $qg->questions();
+				$questions[ $qg->ID() ]                  = $qg->model_field_array();
+				$questions[ $qg->ID() ]['QSG_questions'] = [];
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer                                                                   =
+						EEM_Answer::instance()->get_one(
+							[
+								[
+									'QST_ID' => $qst->ID(),
+									'REG_ID' => $registration->ID(),
+								],
+							]
+						);
+					$answer                                                                   =
+						$answer instanceof EE_Answer
+							? $answer
+							: EEM_Answer::instance()->create_default_object();
+					$qst_name                                                                 = $qstn_id = $qst->ID();
+					$ans_id                                                                   = $answer->ID();
+					$qst_name                                                                 = ! empty($ans_id)
+						? '[' . $qst_name . '][' . $ans_id . ']'
+						: '[' . $qst_name . ']';
+					$input_name                                                               = '';
+					$input_id                                                                 =
+						sanitize_key($qst->display_text());
+					$input_class                                                              = '';
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]                    =
+						$qst->model_field_array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name']  = 'qstn'
+																								. $input_name
+																								. $qst_name;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id']    =
+						$input_id . '-' . $qstn_id;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options']     = [];
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj']         = $qst;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj']         = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] =
+									$QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

core/libraries/form_sections/strategies/layout/EE_Form_Section_Layout_Base.strategy.php

Indentation +261 added lines, -261 removed lines

@@ -11,175 +11,175 @@ 
  */
 abstract class EE_Form_Section_Layout_Base
 {
-    /**
-     * Form section to lay out
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_form_section;
-
-
-
-    /**
-     *  __construct
-     */
-    public function __construct()
-    {
-    }
-
-
-
-    /**
-     * The form section on which this strategy is to perform
-     *
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        $this->_form_section = $form;
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     */
-    public function form_section()
-    {
-        return $this->_form_section;
-    }
-
-
-
-    /**
-     * Also has teh side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string HTML for displaying
-     * @throws EE_Error
-     */
-    public function layout_form()
-    {
-        $html = '';
-        // layout_form_begin
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
-            $this->layout_form_begin(),
-            $this->_form_section
-        );
-        // layout_form_loop
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
-            $this->layout_form_loop(),
-            $this->_form_section
-        );
-        // layout_form_end
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
-            $this->layout_form_end(),
-            $this->_form_section
-        );
-        return $this->add_form_section_hooks_and_filters($html);
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function layout_form_loop()
-    {
-        $html = '';
-        foreach ($this->_form_section->subsections() as $name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_input($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            } elseif ($subsection instanceof EE_Form_Section_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_subsection($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_begin();
-
-
-
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_end();
-
-
-
-    /**
-     * Should be used internally by layout_form() to lay out each input (eg, if this layout
-     * is putting each input in a row of its own, this should probably be called by a
-     *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
-     * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
-     * customize the form's layout, but would like to make use of it for laying out
-     * 'easy-to-layout' inputs
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string html
-     */
-    abstract public function layout_input($input);
-
-
-
-    /**
-     * Similar to layout_input(), should be used internally by layout_form() within a
-     * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed
-     * that the proper subsection will lay out its container, label, etc on its own.
-     *
-     * @param EE_Form_Section_Base $subsection
-     * @return string html
-     */
-    abstract public function layout_subsection($subsection);
-
-
-    /**
-     * Gets the HTML for the label tag and its contents for the input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_label($input)
-    {
-        $label_text = $input->html_label_text();
-        if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-            return '';
-        }
-        $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
-            : $input->html_label_class();
-        $label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
-        return '
+	/**
+	 * Form section to lay out
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_form_section;
+
+
+
+	/**
+	 *  __construct
+	 */
+	public function __construct()
+	{
+	}
+
+
+
+	/**
+	 * The form section on which this strategy is to perform
+	 *
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		$this->_form_section = $form;
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 */
+	public function form_section()
+	{
+		return $this->_form_section;
+	}
+
+
+
+	/**
+	 * Also has teh side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string HTML for displaying
+	 * @throws EE_Error
+	 */
+	public function layout_form()
+	{
+		$html = '';
+		// layout_form_begin
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+			$this->layout_form_begin(),
+			$this->_form_section
+		);
+		// layout_form_loop
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+			$this->layout_form_loop(),
+			$this->_form_section
+		);
+		// layout_form_end
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+			$this->layout_form_end(),
+			$this->_form_section
+		);
+		return $this->add_form_section_hooks_and_filters($html);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function layout_form_loop()
+	{
+		$html = '';
+		foreach ($this->_form_section->subsections() as $name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_input($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			} elseif ($subsection instanceof EE_Form_Section_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_subsection($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_begin();
+
+
+
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_end();
+
+
+
+	/**
+	 * Should be used internally by layout_form() to lay out each input (eg, if this layout
+	 * is putting each input in a row of its own, this should probably be called by a
+	 *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
+	 * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
+	 * customize the form's layout, but would like to make use of it for laying out
+	 * 'easy-to-layout' inputs
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string html
+	 */
+	abstract public function layout_input($input);
+
+
+
+	/**
+	 * Similar to layout_input(), should be used internally by layout_form() within a
+	 * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed
+	 * that the proper subsection will lay out its container, label, etc on its own.
+	 *
+	 * @param EE_Form_Section_Base $subsection
+	 * @return string html
+	 */
+	abstract public function layout_subsection($subsection);
+
+
+	/**
+	 * Gets the HTML for the label tag and its contents for the input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_label($input)
+	{
+		$label_text = $input->html_label_text();
+		if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+			return '';
+		}
+		$class = $input->required()
+			? 'ee-required-label ' . $input->html_label_class()
+			: $input->html_label_class();
+		$label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
+		return '
         <label id="' . $input->html_label_id() . '"
                class="' . $class . '"
                style="' . $input->html_label_style() . '"
@@ -187,102 +187,102 @@ 
         >
             ' . $label_text . '
         </label>';
-    }
-
-
-
-    /**
-     * Gets the HTML for all the form's form-wide errors (ie, errors which
-     * are not for specific inputs. E.g., if two inputs somehow disagree,
-     * those errors would probably be on the form section, not one of its inputs)
-     * @return string
-     */
-    public function display_form_wide_errors()
-    {
-        $html = '';
-        if ($this->_form_section->get_validation_errors()) {
-            $html .= "<div class='ee-form-wide-errors'>";
-            // get all the errors on THIS form section (errors which aren't
-            // for specific inputs, but instead for the entire form section)
-            foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
-            }
-            $html .= '</div>';
-        }
-        return apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
-            $html,
-            $this
-        );
-    }
-
-
-    /**
-     * returns the HTML for the server-side validation errors for the specified input
-     * Note that if JS is enabled, it should remove these and instead
-     * populate the form's errors in the jquery validate fashion
-     * using the localized data provided to the JS
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_errors($input)
-    {
-        if ($input->get_validation_errors()) {
-            return "<label  id='"
-                   . $input->html_id()
-                   . "-error' class='error' for='{$input->html_name()}'>"
-                   . $input->get_validation_error_string()
-                   . '</label>';
-        }
-        return '';
-    }
-
-
-    /**
-     * Displays the help span for the specified input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_help_text($input)
-    {
-        $help_text = $input->html_help_text();
-        if (! $help_text) {
-            return '';
-        }
-        $tag = is_admin() ? 'p' : 'span';
-        return '
+	}
+
+
+
+	/**
+	 * Gets the HTML for all the form's form-wide errors (ie, errors which
+	 * are not for specific inputs. E.g., if two inputs somehow disagree,
+	 * those errors would probably be on the form section, not one of its inputs)
+	 * @return string
+	 */
+	public function display_form_wide_errors()
+	{
+		$html = '';
+		if ($this->_form_section->get_validation_errors()) {
+			$html .= "<div class='ee-form-wide-errors'>";
+			// get all the errors on THIS form section (errors which aren't
+			// for specific inputs, but instead for the entire form section)
+			foreach ($this->_form_section->get_validation_errors() as $error) {
+				$html .= $error->getMessage() . '<br>';
+			}
+			$html .= '</div>';
+		}
+		return apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
+			$html,
+			$this
+		);
+	}
+
+
+	/**
+	 * returns the HTML for the server-side validation errors for the specified input
+	 * Note that if JS is enabled, it should remove these and instead
+	 * populate the form's errors in the jquery validate fashion
+	 * using the localized data provided to the JS
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_errors($input)
+	{
+		if ($input->get_validation_errors()) {
+			return "<label  id='"
+				   . $input->html_id()
+				   . "-error' class='error' for='{$input->html_name()}'>"
+				   . $input->get_validation_error_string()
+				   . '</label>';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Displays the help span for the specified input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_help_text($input)
+	{
+		$help_text = $input->html_help_text();
+		if (! $help_text) {
+			return '';
+		}
+		$tag = is_admin() ? 'p' : 'span';
+		return '
         <' . $tag . ' id="' . esc_attr($input->html_id()) . '-help"
               class="' . esc_attr($input->html_help_class()) . '"
               style="' . esc_attr($input->html_help_style()) . '"
         >
             ' . $help_text . '
         </' . $tag . '>';
-    }
-
-
-    /**
-     * Does an action and hook onto the end of teh form
-     *
-     * @param string $html
-     * @return string
-     * @throws EE_Error
-     */
-    public function add_form_section_hooks_and_filters($html)
-    {
-        // replace dashes and spaces with underscores
-        $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
-            $html,
-            $this->_form_section
-        );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
-        return $html;
-    }
+	}
+
+
+	/**
+	 * Does an action and hook onto the end of teh form
+	 *
+	 * @param string $html
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function add_form_section_hooks_and_filters($html)
+	{
+		// replace dashes and spaces with underscores
+		$hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
+		do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+		$html = (string) apply_filters(
+			'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+			$html,
+			$this->_form_section
+		);
+		$html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
+		$html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+		return $html;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -66,19 +66,19 @@ 
         $html = '';
         // layout_form_begin
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(),
             $this->layout_form_begin(),
             $this->_form_section
         );
         // layout_form_loop
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(),
             $this->layout_form_loop(),
             $this->_form_section
         );
         // layout_form_end
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(),
             $this->layout_form_end(),
             $this->_form_section
         );
@@ -98,7 +98,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_input($subsection),
                     $this->_form_section,
                     $subsection
@@ -106,7 +106,7 @@ 
             } elseif ($subsection instanceof EE_Form_Section_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_subsection($subsection),
                     $this->_form_section,
                     $subsection
@@ -172,20 +172,20 @@ 
     public function display_label($input)
     {
         $label_text = $input->html_label_text();
-        if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+        if ( ! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
             return '';
         }
         $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
+            ? 'ee-required-label '.$input->html_label_class()
             : $input->html_label_class();
         $label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
         return '
-        <label id="' . $input->html_label_id() . '"
-               class="' . $class . '"
-               style="' . $input->html_label_style() . '"
-               for="' . $input->html_id() . '"
+        <label id="' . $input->html_label_id().'"
+               class="' . $class.'"
+               style="' . $input->html_label_style().'"
+               for="' . $input->html_id().'"
         >
-            ' . $label_text . '
+            ' . $label_text.'
         </label>';
     }
 
@@ -205,7 +205,7 @@ 
             // get all the errors on THIS form section (errors which aren't
             // for specific inputs, but instead for the entire form section)
             foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
+                $html .= $error->getMessage().'<br>';
             }
             $html .= '</div>';
         }
@@ -250,17 +250,17 @@ 
     public function display_help_text($input)
     {
         $help_text = $input->html_help_text();
-        if (! $help_text) {
+        if ( ! $help_text) {
             return '';
         }
         $tag = is_admin() ? 'p' : 'span';
         return '
-        <' . $tag . ' id="' . esc_attr($input->html_id()) . '-help"
-              class="' . esc_attr($input->html_help_class()) . '"
-              style="' . esc_attr($input->html_help_style()) . '"
+        <' . $tag.' id="'.esc_attr($input->html_id()).'-help"
+              class="' . esc_attr($input->html_help_class()).'"
+              style="' . esc_attr($input->html_help_style()).'"
         >
-            ' . $help_text . '
-        </' . $tag . '>';
+            ' . $help_text.'
+        </' . $tag.'>';
     }
 
 
@@ -275,14 +275,14 @@ 
     {
         // replace dashes and spaces with underscores
         $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+        do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section);
         $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+            'AFEE__Form_Section_Layout__'.$hook_name.'__html',
             $html,
             $this->_form_section
         );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+        $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->';
+        $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->';
         return $html;
     }
 }

core/libraries/form_sections/strategies/layout/EE_Admin_Two_Column_Layout.strategy.php

Indentation +76 added lines, -76 removed lines

@@ -6,85 +6,85 @@
  */
 class EE_Admin_Two_Column_Layout extends EE_Two_Column_Layout
 {
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        parent::_construct_finalize($form);
-        $this->_form_section->set_html_class('ee-admin-two-column-layout form-table');
-    }
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		parent::_construct_finalize($form);
+		$this->_form_section->set_html_class('ee-admin-two-column-layout form-table');
+	}
 
 
-    /**
-     * Overriding the parent table layout to include <tbody> tags
-     *
-     * @param array $additional_args
-     * @return string
-     * @throws EE_Error
-     */
-    public function layout_form_begin($additional_args = array())
-    {
-        return parent::layout_form_begin($additional_args);
-    }
+	/**
+	 * Overriding the parent table layout to include <tbody> tags
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function layout_form_begin($additional_args = array())
+	{
+		return parent::layout_form_begin($additional_args);
+	}
 
 
 
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function layout_input($input)
-    {
-        if (
-            $input->get_display_strategy() instanceof EE_Select_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
-        ) {
-            $html_class = $input->html_class();
-            $html_class = strpos($html_class, 'ee-input-width') === false
-                ? "$html_class ee-input-width--big"
-                : $html_class;
-            $input->set_html_class($html_class);
-        }
-        if ($input instanceof EE_Text_Area_Input) {
-            $input->set_rows(4);
-            $input->set_cols(60);
-        }
-        $input_html = $input->get_html_for_input();
-        // maybe add errors and help text ?
-        $input_html .= $input->get_html_for_errors() !== ''
-            ? EEH_HTML::nl() . $input->get_html_for_errors()
-            : '';
-        $input_html .= $input->get_html_for_help() !== ''
-            ? EEH_HTML::nl() . $input->get_html_for_help()
-            : '';
-        $input_html .= $input->extraContainerHtml() !== ''
-            ? EEH_HTML::nl() . $input->extraContainerHtml()
-            : '';
-        // overriding parent to add wp admin specific things.
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::no_row($input->get_html_for_input());
-            // $html .= $input->get_html_for_input();
-        } else {
-            $html .= EEH_HTML::tr(
-                EEH_HTML::th(
-                    $input->get_html_for_label(),
-                    '',
-                    '',
-                    '',
-                    'scope="row"'
-                )
-                . EEH_HTML::td($input_html),
-                sanitize_key($input->html_id()) . '-tr',
-                $input->layoutContainerClass()
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function layout_input($input)
+	{
+		if (
+			$input->get_display_strategy() instanceof EE_Select_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
+		) {
+			$html_class = $input->html_class();
+			$html_class = strpos($html_class, 'ee-input-width') === false
+				? "$html_class ee-input-width--big"
+				: $html_class;
+			$input->set_html_class($html_class);
+		}
+		if ($input instanceof EE_Text_Area_Input) {
+			$input->set_rows(4);
+			$input->set_cols(60);
+		}
+		$input_html = $input->get_html_for_input();
+		// maybe add errors and help text ?
+		$input_html .= $input->get_html_for_errors() !== ''
+			? EEH_HTML::nl() . $input->get_html_for_errors()
+			: '';
+		$input_html .= $input->get_html_for_help() !== ''
+			? EEH_HTML::nl() . $input->get_html_for_help()
+			: '';
+		$input_html .= $input->extraContainerHtml() !== ''
+			? EEH_HTML::nl() . $input->extraContainerHtml()
+			: '';
+		// overriding parent to add wp admin specific things.
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::no_row($input->get_html_for_input());
+			// $html .= $input->get_html_for_input();
+		} else {
+			$html .= EEH_HTML::tr(
+				EEH_HTML::th(
+					$input->get_html_for_label(),
+					'',
+					'',
+					'',
+					'scope="row"'
+				)
+				. EEH_HTML::td($input_html),
+				sanitize_key($input->html_id()) . '-tr',
+				$input->layoutContainerClass()
+			);
+		}
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -58,13 +58,13 @@ 
         $input_html = $input->get_html_for_input();
         // maybe add errors and help text ?
         $input_html .= $input->get_html_for_errors() !== ''
-            ? EEH_HTML::nl() . $input->get_html_for_errors()
+            ? EEH_HTML::nl().$input->get_html_for_errors()
             : '';
         $input_html .= $input->get_html_for_help() !== ''
-            ? EEH_HTML::nl() . $input->get_html_for_help()
+            ? EEH_HTML::nl().$input->get_html_for_help()
             : '';
         $input_html .= $input->extraContainerHtml() !== ''
-            ? EEH_HTML::nl() . $input->extraContainerHtml()
+            ? EEH_HTML::nl().$input->extraContainerHtml()
             : '';
         // overriding parent to add wp admin specific things.
         $html = '';
@@ -81,7 +81,7 @@ 
                     'scope="row"'
                 )
                 . EEH_HTML::td($input_html),
-                sanitize_key($input->html_id()) . '-tr',
+                sanitize_key($input->html_id()).'-tr',
                 $input->layoutContainerClass()
             );
         }

core/libraries/form_sections/strategies/display/EE_Display_Strategy_Base.strategy.php

Indentation +238 added lines, -238 removed lines

@@ -10,242 +10,242 @@
  */
 abstract class EE_Display_Strategy_Base extends EE_Form_Input_Strategy_Base
 {
-    /**
-     * @var string $_tag
-     */
-    protected string $_tag = '';
-
-
-    /**
-     * returns HTML and javascript related to the displaying of this input
-     *
-     * @return string
-     */
-    abstract public function display(): string;
-
-
-    /**
-     * _remove_chars - takes an incoming string, and removes the string $chars from the end of it, but only if $chars
-     * is already there
-     *
-     * @param string $string - the string being processed
-     * @param string $chars  - exact string of characters to remove
-     * @return string
-     */
-    protected function _remove_chars(string $string = '', string $chars = '-'): string
-    {
-        $char_length = strlen($chars) * -1;
-        // if last three characters of string is  " - ", then remove it
-        return substr($string, $char_length) === $chars
-            ? substr($string, 0, $char_length)
-            : $string;
-    }
-
-
-    /**
-     * _append_chars - takes an incoming string, and adds the string $chars to the end of it, but only if $chars is not
-     * already there
-     *
-     * @param string $string - the string being processed
-     * @param string $chars  - exact string of characters to be added to end of string
-     * @return string
-     */
-    protected function _append_chars(string $string = '', string $chars = '-'): string
-    {
-        return $this->_remove_chars($string, $chars) . $chars;
-    }
-
-
-    /**
-     * Gets the HTML IDs of all the inputs
-     *
-     * @param bool $add_pound_sign
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_html_input_ids(bool $add_pound_sign = false): array
-    {
-        return [$this->get_input()->html_id($add_pound_sign)];
-    }
-
-
-    /**
-     * Adds js variables for localization to the $other_js_data. These should be put
-     * in each form's "other_data" javascript object.
-     *
-     * @param array $other_js_data
-     * @return array
-     */
-    public function get_other_js_data(array $other_js_data = []): array
-    {
-        return $other_js_data;
-    }
-
-
-    /**
-     * Opportunity for this display strategy to call wp_enqueue_script and wp_enqueue_style.
-     * This should be called during wp_enqueue_scripts
-     */
-    public function enqueue_js()
-    {
-    }
-
-
-    /**
-     * returns string like: '<tag'
-     *
-     * @param string $tag
-     * @return string
-     */
-    protected function _opening_tag(string $tag): string
-    {
-        $this->_tag = $tag;
-        return "<$this->_tag";
-    }
-
-
-    /**
-     * returns string like: '</tag>
-     *
-     * @return string
-     */
-    protected function _closing_tag(): string
-    {
-        return "</$this->_tag>";
-    }
-
-
-    /**
-     * returns string like: '/>'
-     *
-     * @return string
-     */
-    protected function _close_tag(): string
-    {
-        return '/>';
-    }
-
-
-    /**
-     * returns an array of standard HTML attributes that get added to nearly all inputs,
-     * where string keys represent named attributes like id, class, etc
-     * and numeric keys represent single attributes like 'required'.
-     * Note: this does not include "value" because many inputs (like dropdowns, textareas, and checkboxes) don't use
-     * it.
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _standard_attributes_array(): array
-    {
-        return [
-            'name'  => $this->_input->html_name(),
-            'id'    => $this->_input->html_id(),
-            'class' => $this->_input->html_class(true),
-            0       => ['required', $this->_input->required()],
-            1       => $this->_input->other_html_attributes(),
-            'style' => $this->_input->html_style(),
-        ];
-    }
-
-
-    /**
-     * sets the attributes using the incoming array
-     * and returns a string of all attributes rendered as valid HTML
-     *
-     * @param array $attributes
-     * @return string
-     */
-    protected function _attributes_string(array $attributes = []): string
-    {
-        $attributes        = apply_filters(
-            'FHEE__EE_Display_Strategy_Base__attributes_string__attributes',
-            $attributes,
-            $this,
-            $this->_input
-        );
-        $attributes_string = '';
-        foreach ($attributes as $attribute => $value) {
-            if ($attribute !== 'value' && empty($value)) {
-                continue;
-            }
-            if (is_numeric($attribute)) {
-                $add = true;
-                if (is_array($value)) {
-                    $attribute = $value[0] ?? '';
-                    $add       = $value[1] ?? false;
-                } else {
-                    $attribute = $value;
-                }
-                $attributes_string .= $this->_single_attribute($attribute, $add);
-            } else {
-                $attributes_string .= $this->_attribute($attribute, $value);
-            }
-        }
-        return $attributes_string;
-    }
-
-
-    /**
-     * returns string like: ' attribute="value"'
-     * returns an empty string if $value is null
-     *
-     * @param string $attribute
-     * @param string $value
-     * @return string
-     */
-    protected function _attribute(string $attribute, string $value = ''): string
-    {
-        if ($value === null) {
-            return '';
-        }
-        $value = esc_attr($value);
-        return " $attribute=\"$value\"";
-    }
-
-
-    /**
-     * returns string like: ' data-attribute-one="value-one" data-attribute-two="value-two"'
-     *
-     * @param array $data
-     * @return string
-     */
-    protected function dataAttributesString(array $data): string
-    {
-        $data_attributes = '';
-        foreach ($data as $attribute => $value) {
-            $data_attributes .= $this->_data_attribute($attribute, $value);
-        }
-        return $data_attributes;
-    }
-
-
-    /**
-     * returns string like: ' data-attribute="value"'
-     * returns an empty string if $value is null
-     *
-     * @param string $attribute
-     * @param string $value
-     * @return string
-     */
-    protected function _data_attribute(string $attribute, string $value = ''): string
-    {
-        $attribute = strpos($attribute, 'data-') !== 0 ? "data-$attribute" : $attribute;
-        return $this->_attribute($attribute, $value);
-    }
-
-
-    /**
-     * returns string like: ' attribute' if $add is true
-     *
-     * @param string  $attribute
-     * @param boolean $add
-     * @return string
-     */
-    protected function _single_attribute(string $attribute, bool $add = true): string
-    {
-        return $add
-            ? " $attribute"
-            : '';
-    }
+	/**
+	 * @var string $_tag
+	 */
+	protected string $_tag = '';
+
+
+	/**
+	 * returns HTML and javascript related to the displaying of this input
+	 *
+	 * @return string
+	 */
+	abstract public function display(): string;
+
+
+	/**
+	 * _remove_chars - takes an incoming string, and removes the string $chars from the end of it, but only if $chars
+	 * is already there
+	 *
+	 * @param string $string - the string being processed
+	 * @param string $chars  - exact string of characters to remove
+	 * @return string
+	 */
+	protected function _remove_chars(string $string = '', string $chars = '-'): string
+	{
+		$char_length = strlen($chars) * -1;
+		// if last three characters of string is  " - ", then remove it
+		return substr($string, $char_length) === $chars
+			? substr($string, 0, $char_length)
+			: $string;
+	}
+
+
+	/**
+	 * _append_chars - takes an incoming string, and adds the string $chars to the end of it, but only if $chars is not
+	 * already there
+	 *
+	 * @param string $string - the string being processed
+	 * @param string $chars  - exact string of characters to be added to end of string
+	 * @return string
+	 */
+	protected function _append_chars(string $string = '', string $chars = '-'): string
+	{
+		return $this->_remove_chars($string, $chars) . $chars;
+	}
+
+
+	/**
+	 * Gets the HTML IDs of all the inputs
+	 *
+	 * @param bool $add_pound_sign
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_html_input_ids(bool $add_pound_sign = false): array
+	{
+		return [$this->get_input()->html_id($add_pound_sign)];
+	}
+
+
+	/**
+	 * Adds js variables for localization to the $other_js_data. These should be put
+	 * in each form's "other_data" javascript object.
+	 *
+	 * @param array $other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data(array $other_js_data = []): array
+	{
+		return $other_js_data;
+	}
+
+
+	/**
+	 * Opportunity for this display strategy to call wp_enqueue_script and wp_enqueue_style.
+	 * This should be called during wp_enqueue_scripts
+	 */
+	public function enqueue_js()
+	{
+	}
+
+
+	/**
+	 * returns string like: '<tag'
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	protected function _opening_tag(string $tag): string
+	{
+		$this->_tag = $tag;
+		return "<$this->_tag";
+	}
+
+
+	/**
+	 * returns string like: '</tag>
+	 *
+	 * @return string
+	 */
+	protected function _closing_tag(): string
+	{
+		return "</$this->_tag>";
+	}
+
+
+	/**
+	 * returns string like: '/>'
+	 *
+	 * @return string
+	 */
+	protected function _close_tag(): string
+	{
+		return '/>';
+	}
+
+
+	/**
+	 * returns an array of standard HTML attributes that get added to nearly all inputs,
+	 * where string keys represent named attributes like id, class, etc
+	 * and numeric keys represent single attributes like 'required'.
+	 * Note: this does not include "value" because many inputs (like dropdowns, textareas, and checkboxes) don't use
+	 * it.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _standard_attributes_array(): array
+	{
+		return [
+			'name'  => $this->_input->html_name(),
+			'id'    => $this->_input->html_id(),
+			'class' => $this->_input->html_class(true),
+			0       => ['required', $this->_input->required()],
+			1       => $this->_input->other_html_attributes(),
+			'style' => $this->_input->html_style(),
+		];
+	}
+
+
+	/**
+	 * sets the attributes using the incoming array
+	 * and returns a string of all attributes rendered as valid HTML
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	protected function _attributes_string(array $attributes = []): string
+	{
+		$attributes        = apply_filters(
+			'FHEE__EE_Display_Strategy_Base__attributes_string__attributes',
+			$attributes,
+			$this,
+			$this->_input
+		);
+		$attributes_string = '';
+		foreach ($attributes as $attribute => $value) {
+			if ($attribute !== 'value' && empty($value)) {
+				continue;
+			}
+			if (is_numeric($attribute)) {
+				$add = true;
+				if (is_array($value)) {
+					$attribute = $value[0] ?? '';
+					$add       = $value[1] ?? false;
+				} else {
+					$attribute = $value;
+				}
+				$attributes_string .= $this->_single_attribute($attribute, $add);
+			} else {
+				$attributes_string .= $this->_attribute($attribute, $value);
+			}
+		}
+		return $attributes_string;
+	}
+
+
+	/**
+	 * returns string like: ' attribute="value"'
+	 * returns an empty string if $value is null
+	 *
+	 * @param string $attribute
+	 * @param string $value
+	 * @return string
+	 */
+	protected function _attribute(string $attribute, string $value = ''): string
+	{
+		if ($value === null) {
+			return '';
+		}
+		$value = esc_attr($value);
+		return " $attribute=\"$value\"";
+	}
+
+
+	/**
+	 * returns string like: ' data-attribute-one="value-one" data-attribute-two="value-two"'
+	 *
+	 * @param array $data
+	 * @return string
+	 */
+	protected function dataAttributesString(array $data): string
+	{
+		$data_attributes = '';
+		foreach ($data as $attribute => $value) {
+			$data_attributes .= $this->_data_attribute($attribute, $value);
+		}
+		return $data_attributes;
+	}
+
+
+	/**
+	 * returns string like: ' data-attribute="value"'
+	 * returns an empty string if $value is null
+	 *
+	 * @param string $attribute
+	 * @param string $value
+	 * @return string
+	 */
+	protected function _data_attribute(string $attribute, string $value = ''): string
+	{
+		$attribute = strpos($attribute, 'data-') !== 0 ? "data-$attribute" : $attribute;
+		return $this->_attribute($attribute, $value);
+	}
+
+
+	/**
+	 * returns string like: ' attribute' if $add is true
+	 *
+	 * @param string  $attribute
+	 * @param boolean $add
+	 * @return string
+	 */
+	protected function _single_attribute(string $attribute, bool $add = true): string
+	{
+		return $add
+			? " $attribute"
+			: '';
+	}
 }

core/libraries/form_sections/strategies/display/EE_Text_Input_Display_Strategy.strategy.php

Indentation +51 added lines, -51 removed lines

@@ -14,61 +14,61 @@
  */
 class EE_Text_Input_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * The html "type" attribute value. default is "text"
-     *
-     * @var string
-     */
-    protected string $_type;
+	/**
+	 * The html "type" attribute value. default is "text"
+	 *
+	 * @var string
+	 */
+	protected string $_type;
 
 
-    /**
-     * @param string $type
-     */
-    public function __construct(string $type = 'text')
-    {
-        $this->_type = $type;
-        parent::__construct();
-    }
+	/**
+	 * @param string $type
+	 */
+	public function __construct(string $type = 'text')
+	{
+		$this->_type = $type;
+		parent::__construct();
+	}
 
 
-    /**
-     * Gets the html "type" attribute's value
-     *
-     * @return string
-     */
-    public function get_type(): string
-    {
-        if (
-            $this->_type === 'email'
-            && ! apply_filters('FHEE__EE_Text_Input_Display_Strategy__use_html5_email', true)
-        ) {
-            return 'text';
-        }
-        return $this->_type;
-    }
+	/**
+	 * Gets the html "type" attribute's value
+	 *
+	 * @return string
+	 */
+	public function get_type(): string
+	{
+		if (
+			$this->_type === 'email'
+			&& ! apply_filters('FHEE__EE_Text_Input_Display_Strategy__use_html5_email', true)
+		) {
+			return 'text';
+		}
+		return $this->_type;
+	}
 
 
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        $input = '<input type="' . $this->get_type() . '"';
-        $input .= ' name="' . $this->_input->html_name() . '"';
-        $input .= ' id="' . $this->_input->html_id() . '"';
-        $class = $this->_input->required()
-            ? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
-            : $this->_input->html_class();
-        $input .= ' class="' . $class . '"';
-        // add html5 required
-        $input .= $this->_input->required() ? ' required' : '';
-        $input .= ' value="' . $this->_input->raw_value_in_form() . '"';
-        $input .= ' style="' . $this->_input->html_style() . '"';
-        $input .= $this->_input->other_html_attributes();
-        $input .= $this->dataAttributesString($this->_input->dataAttributes());
-        $input .= '/>';
-        return $input;
-    }
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		$input = '<input type="' . $this->get_type() . '"';
+		$input .= ' name="' . $this->_input->html_name() . '"';
+		$input .= ' id="' . $this->_input->html_id() . '"';
+		$class = $this->_input->required()
+			? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
+			: $this->_input->html_class();
+		$input .= ' class="' . $class . '"';
+		// add html5 required
+		$input .= $this->_input->required() ? ' required' : '';
+		$input .= ' value="' . $this->_input->raw_value_in_form() . '"';
+		$input .= ' style="' . $this->_input->html_style() . '"';
+		$input .= $this->_input->other_html_attributes();
+		$input .= $this->dataAttributesString($this->_input->dataAttributes());
+		$input .= '/>';
+		return $input;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -55,17 +55,17 @@
      */
     public function display(): string
     {
-        $input = '<input type="' . $this->get_type() . '"';
-        $input .= ' name="' . $this->_input->html_name() . '"';
-        $input .= ' id="' . $this->_input->html_id() . '"';
+        $input = '<input type="'.$this->get_type().'"';
+        $input .= ' name="'.$this->_input->html_name().'"';
+        $input .= ' id="'.$this->_input->html_id().'"';
         $class = $this->_input->required()
-            ? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
+            ? $this->_input->required_css_class().' '.$this->_input->html_class()
             : $this->_input->html_class();
-        $input .= ' class="' . $class . '"';
+        $input .= ' class="'.$class.'"';
         // add html5 required
         $input .= $this->_input->required() ? ' required' : '';
-        $input .= ' value="' . $this->_input->raw_value_in_form() . '"';
-        $input .= ' style="' . $this->_input->html_style() . '"';
+        $input .= ' value="'.$this->_input->raw_value_in_form().'"';
+        $input .= ' style="'.$this->_input->html_style().'"';
         $input .= $this->_input->other_html_attributes();
         $input .= $this->dataAttributesString($this->_input->dataAttributes());
         $input .= '/>';

core/libraries/form_sections/strategies/display/EE_Select_Multiple_Display_Strategy.strategy.php

Indentation +58 added lines, -58 removed lines

@@ -9,67 +9,67 @@
  */
 class EE_Select_Multiple_Display_Strategy extends EE_Select_Display_Strategy
 {
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(
-                esc_html__(
-                    'Cannot use Select Multiple Display Strategy with an input that doesn\'t have options',
-                    "event_espresso"
-                )
-            );
-        }
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(
+				esc_html__(
+					'Cannot use Select Multiple Display Strategy with an input that doesn\'t have options',
+					"event_espresso"
+				)
+			);
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select multiple';
-        $html .= ' id="' . $this->_input->html_id() . '"';
-        $html .= ' name="' . $this->_input->html_name() . '[]"';
-        $class = $this->_input->required()
-            ? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
-            : $this->_input->html_class();
-        $html .= ' class="' . $class . '"';
-        // add html5 required
-        $html .= $this->_input->required()
-            ? ' required'
-            : '';
-        $html .= ' style="' . $this->_input->html_style() . '"';
-        $html .= $this->_input->other_html_attributes();
-        $html .= $this->dataAttributesString($this->_input->dataAttributes());
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select multiple';
+		$html .= ' id="' . $this->_input->html_id() . '"';
+		$html .= ' name="' . $this->_input->html_name() . '[]"';
+		$class = $this->_input->required()
+			? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
+			: $this->_input->html_class();
+		$html .= ' class="' . $class . '"';
+		// add html5 required
+		$html .= $this->_input->required()
+			? ' required'
+			: '';
+		$html .= ' style="' . $this->_input->html_style() . '"';
+		$html .= $this->_input->other_html_attributes();
+		$html .= $this->dataAttributesString($this->_input->dataAttributes());
+		$html .= '>';
 
-        EEH_HTML::indent(1, 'select');
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            throw new EE_Error(
-                esc_html__(
-                    "Select multiple display strategy does not allow for nested arrays of options.",
-                    "event_espresso"
-                )
-            );
-        } else {
-            $html .= $this->_display_options($this->_input->options());
-        }
+		EEH_HTML::indent(1, 'select');
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			throw new EE_Error(
+				esc_html__(
+					"Select multiple display strategy does not allow for nested arrays of options.",
+					"event_espresso"
+				)
+			);
+		} else {
+			$html .= $this->_display_options($this->_input->options());
+		}
 
-        $html .= EEH_HTML::nl(-1, 'select') . "</select>";
-        return $html;
-    }
+		$html .= EEH_HTML::nl(-1, 'select') . "</select>";
+		return $html;
+	}
 
 
-    /**
-     * Checks if that $value is one of the selected ones
-     *
-     * @param string|int $value unnormalized value option (string)
-     * @return bool
-     */
-    protected function _check_if_option_selected($value): bool
-    {
-        $selected_options = $this->_input->raw_value();
-        if (empty($selected_options)) {
-            return false;
-        }
-        return in_array($value, $selected_options);
-    }
+	/**
+	 * Checks if that $value is one of the selected ones
+	 *
+	 * @param string|int $value unnormalized value option (string)
+	 * @return bool
+	 */
+	protected function _check_if_option_selected($value): bool
+	{
+		$selected_options = $this->_input->raw_value();
+		if (empty($selected_options)) {
+			return false;
+		}
+		return in_array($value, $selected_options);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -15,7 +15,7 @@ 
      */
     public function display(): string
     {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(
                 esc_html__(
                     'Cannot use Select Multiple Display Strategy with an input that doesn\'t have options',
@@ -26,17 +26,17 @@ 
 
         $html = EEH_HTML::nl(0, 'select');
         $html .= '<select multiple';
-        $html .= ' id="' . $this->_input->html_id() . '"';
-        $html .= ' name="' . $this->_input->html_name() . '[]"';
+        $html .= ' id="'.$this->_input->html_id().'"';
+        $html .= ' name="'.$this->_input->html_name().'[]"';
         $class = $this->_input->required()
-            ? $this->_input->required_css_class() . ' ' . $this->_input->html_class()
+            ? $this->_input->required_css_class().' '.$this->_input->html_class()
             : $this->_input->html_class();
-        $html .= ' class="' . $class . '"';
+        $html .= ' class="'.$class.'"';
         // add html5 required
         $html .= $this->_input->required()
             ? ' required'
             : '';
-        $html .= ' style="' . $this->_input->html_style() . '"';
+        $html .= ' style="'.$this->_input->html_style().'"';
         $html .= $this->_input->other_html_attributes();
         $html .= $this->dataAttributesString($this->_input->dataAttributes());
         $html .= '>';
@@ -53,7 +53,7 @@ 
             $html .= $this->_display_options($this->_input->options());
         }
 
-        $html .= EEH_HTML::nl(-1, 'select') . "</select>";
+        $html .= EEH_HTML::nl(-1, 'select')."</select>";
         return $html;
     }
 

core/libraries/form_sections/strategies/display/EE_Submit_Input_Display_Strategy.strategy.php

Indentation +27 added lines, -27 removed lines

@@ -9,31 +9,31 @@
  */
 class EE_Submit_Input_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * @return string of html to display the input
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        $default_value = $this->_input->get_default();
-        if ($this->_input->get_normalization_strategy() instanceof EE_Normalization_Strategy_Base) {
-            $default_value = $this->_input->get_normalization_strategy()->unnormalize($default_value);
-        }
-        $html = $this->_opening_tag('input');
-        $html .= $this->_attributes_string(
-            array_merge(
-                $this->_standard_attributes_array(),
-                [
-                    'type'  => 'submit',
-                    'value' => $default_value,
-                    // overwrite the standard id with the backwards compatible one
-                    'id'    => $this->_input->html_id() . '-submit',
-                    'class' => $this->_input->html_class() . ' ' . $this->_input->button_css_attributes(),
-                ]
-            )
-        );
-        $html .= $this->dataAttributesString($this->_input->dataAttributes());
-        $html .= $this->_close_tag();
-        return $html;
-    }
+	/**
+	 * @return string of html to display the input
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		$default_value = $this->_input->get_default();
+		if ($this->_input->get_normalization_strategy() instanceof EE_Normalization_Strategy_Base) {
+			$default_value = $this->_input->get_normalization_strategy()->unnormalize($default_value);
+		}
+		$html = $this->_opening_tag('input');
+		$html .= $this->_attributes_string(
+			array_merge(
+				$this->_standard_attributes_array(),
+				[
+					'type'  => 'submit',
+					'value' => $default_value,
+					// overwrite the standard id with the backwards compatible one
+					'id'    => $this->_input->html_id() . '-submit',
+					'class' => $this->_input->html_class() . ' ' . $this->_input->button_css_attributes(),
+				]
+			)
+		);
+		$html .= $this->dataAttributesString($this->_input->dataAttributes());
+		$html .= $this->_close_tag();
+		return $html;
+	}
 }