eventespresso / event-espresso-core

core/db_models/EEM_Registration.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -441,7 +441,7 @@ 
      * be passed via a GET parameter.
      *
      * @param string $REG_url_link
-     * @return EE_Registration|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -461,7 +461,7 @@ 
      * @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
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */
@@ -674,7 +674,7 @@ 
      * Returns the EE_Registration of the primary attendee on the transaction id provided
      *
      * @param int $TXN_ID
-     * @return EE_Registration|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +873 added lines, -873 removed lines

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

Spacing +28 added lines, -28 removed lines

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

core/db_models/EEM_Soft_Delete_Base.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -330,7 +330,7 @@
      * this function will ignore whether the items have been soft-deleted or not.
      *
      * @param boolean    $delete true for delete, false for restore
-     * @param int|string $ID     int if primary key is an int, string otherwise
+     * @param integer $ID     int if primary key is an int, string otherwise
      * @return boolean
      * @throws EE_Error
      * @throws ReflectionException

Indentation +398 added lines, -398 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      */
     protected function __construct(string $timezone = '')
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -148,7 +148,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included(array $query_params): array
     {
         $deletedFlagFieldName                     = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -188,7 +188,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included(array $query_params): array
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;

core/db_models/EEM_Term_Relationship.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
     /**
      * Makes sure all term-taxonomy counts are correct
      *
-     * @param int|null $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+     * @param integer $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
      * @return int the number of rows affected
      * @throws EE_Error
      * @global wpdb    $wpdb

Indentation +236 added lines, -236 removed lines

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

Spacing +14 added lines, -14 removed lines

@@ -57,61 +57,61 @@ 
                 ),
             ],
         ];
-        $this->_model_relations    = [
+        $this->_model_relations = [
             'Term_Taxonomy' => new EE_Belongs_To_Relation(),
         ];
         foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model_name] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         $this->_indexes       = [
             'PRIMARY' => new EE_Primary_Key_Index(['object_id', 'term_taxonomy_id']),
         ];
         $path_to_event_model  = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read]
                               = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]
                               = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
         );
-        $path_to_tax_model    = 'Term_Taxonomy.';
+        $path_to_tax_model = 'Term_Taxonomy.';
         // add cap restrictions for editing term relations to the "ee_assign_*"
         // and for deleting term relations too
         $cap_contexts_affected = [EEM_Base::caps_edit, EEM_Base::caps_delete];
         foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_category']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_category' => [
+                    $path_to_tax_model.'taxonomy*ee_assign_event_category' => [
                         '!=',
                         'espresso_event_categories',
                     ],
                 ]
             );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_venue_category']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => [
+                    $path_to_tax_model.'taxonomy*ee_assign_venue_category' => [
                         '!=',
                         'espresso_venue_categories',
                     ],
                 ]
             );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type']
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_type']
                 = new EE_Default_Where_Conditions(
                 [
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
+                    $path_to_tax_model.'taxonomy*ee_assign_event_type' => ['!=', 'espresso_event_type'],
                 ]
             );
         }
@@ -246,7 +246,7 @@ 
     ): array {
         if ($model === EEM_Term_Relationship::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/EEM_Transaction.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -439,7 +439,7 @@ 
      * returns an array of EE_Transaction objects whose timestamp is greater than
      * the current time minus the session lifespan, which defaults to 60 minutes
      *
-     * @return EE_Base_Class[]|EE_Transaction[]
+     * @return EE_Transaction[]
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -456,7 +456,7 @@ 
      * returns an array of EE_Transaction objects whose timestamp is less than
      * the current time minus the session lifespan, which defaults to 60 minutes
      *
-     * @return EE_Base_Class[]|EE_Transaction[]
+     * @return EE_Transaction[]
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Indentation +456 added lines, -456 removed lines

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

Spacing +12 added lines, -12 removed lines

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

core/db_models/fields/EE_Datetime_Field.php

Doc Comments +3 added lines, -3 removed lines

@@ -563,7 +563,7 @@ 
      * allowed)
      *
      * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
+     * @return  null|DbSafeDateTime null | DateTime
      * @throws EE_Error
      */
     public function prepare_for_set_from_db($datetime_string)
@@ -702,7 +702,7 @@ 
      *
      * @param DateTimeZone $DateTimeZone
      * @param int          $time
-     * @return mixed
+     * @return integer
      * @throws DomainException
      */
     public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
@@ -745,7 +745,7 @@ 
     /**
      * Gets the default datetime object from the field's default time
      *
-     * @return DbSafeDateTime|null
+     * @return DateTime|null
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
      * @throws InvalidInterfaceException

Indentation +757 added lines, -757 removed lines

@@ -16,762 +16,762 @@
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-    /**
-     * @type string $_date_format
-     */
-    protected $_date_format = '';
-
-    /**
-     * @type string $_time_format
-     */
-    protected $_time_format = '';
-
-    /**
-     * @type string $_pretty_date_format
-     */
-    protected $_pretty_date_format = '';
-
-    /**
-     * @type string $_pretty_time_format
-     */
-    protected $_pretty_time_format = '';
-
-    /**
-     * @type DateTimeZone $_DateTimeZone
-     */
-    protected $_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_UTC_DateTimeZone
-     */
-    protected $_UTC_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_blog_DateTimeZone
-     */
-    protected $_blog_DateTimeZone;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var string
-     */
-    protected $_date_time_output = '';
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
-     *
-     * @var string
-     */
-    protected $_timezone_string;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected $_blog_offset;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @param string $timezone_string
-     * @param string $date_format
-     * @param string $time_format
-     * @param string $pretty_date_format
-     * @param string $pretty_time_format
-     */
-    public function __construct(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        string $default_value,
-        string $timezone_string = '',
-        string $date_format = '',
-        string $time_format = '',
-        string $pretty_date_format = '',
-        string $pretty_time_format = ''
-    ) {
-
-        $this->_date_format        = ! empty($date_format)
-            ? $date_format
-            : get_option('date_format');
-        $this->_time_format        = ! empty($time_format)
-            ? $time_format
-            : get_option('time_format');
-        $this->_pretty_date_format = ! empty($pretty_date_format)
-            ? $pretty_date_format
-            : get_option('date_format');
-        $this->_pretty_time_format = ! empty($pretty_time_format)
-            ? $pretty_time_format
-            : get_option('time_format');
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaFormat('date-time');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     */
-    public function get_UTC_DateTimeZone(): DateTimeZone
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     */
-    public function get_blog_DateTimeZone(): DateTimeZone
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string();
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
-     *
-     * @param string|int $value_inputted_for_field_on_model_object  could be a string formatted date time or int unix
-     *                                                              timestamp
-     * @return DateTime
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output(bool $pretty = false): string
-    {
-        $pretty = filter_var($pretty, FILTER_VALIDATE_BOOLEAN);
-        switch ($this->_date_time_output) {
-            case 'time':
-                return $pretty
-                    ? $this->_pretty_time_format
-                    : $this->_time_format;
-
-            case 'date':
-                return $pretty
-                    ? $this->_pretty_date_format
-                    : $this->_date_format;
-
-            default:
-                return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string $what acceptable values are 'time' or 'date'.
-     *                     Any other value will be set but will always result
-     *                     in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output(string $what = '')
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
-     * We also set some other properties in this method.
-     *
-     * @param string $timezone_string A valid timezone string as described by @link
-     *                                http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set_timezone(string $timezone_string)
-    {
-        if (empty($timezone_string) && ! empty($this->_timezone_string)) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @param string $timezone_string
-     * @return DateTimeZone
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_timezone_object_from_timezone_string(string $timezone_string = ''): DateTimeZone
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @return string timezone string
-     */
-    public function get_timezone(): string
-    {
-        return $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = $format;
-        } else {
-            $this->_date_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_date_format
-            : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = $format;
-        } else {
-            $this->_time_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_time_format
-            : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format(string $format)
-    {
-        $this->_pretty_date_format = $format;
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format(string $format)
-    {
-        $this->_pretty_time_format = $format;
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = [
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = [
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
-     * datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param DateTime $DateTime
-     * @return string formatted date time for given timezone
-     * @throws EE_Error
-     */
-    public function prepare_for_get($DateTime): string
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param DateTime $DateTime
-     * @param string $schema
-     * @return string
-     * @throws EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, string $schema = 'pretty'): string
-    {
-        return $this->_prepare_for_display($DateTime, $schema);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime $DateTime
-     * @param string   $schema
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _prepare_for_display(DateTime $DateTime, string $schema = ''): string
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                } else {
-                    $DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                }
-            }
-        }
-        $pretty = $schema === 'pretty';
-        $format_string = $this->_get_date_time_output($pretty);
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-
-        $timezone_string = '';
-        if ($this->_display_timezone()) {
-            // must be explicit because schema could equal true.
-            $timezone_string = $schema === 'no_html'
-                ? ' (' . $DateTime->format('T') . ')'
-                : ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-        }
-        return $DateTime->format($format_string) . $timezone_string;
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime|null $datetime_value
-     * @return string mysql timestamp in UTC
-     * @throws EE_Error
-     */
-    public function prepare_for_use_in_db($datetime_value)
-    {
-        // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The incoming value being prepared for setting in the database must either be empty or a php 
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+	/**
+	 * @type string $_date_format
+	 */
+	protected $_date_format = '';
+
+	/**
+	 * @type string $_time_format
+	 */
+	protected $_time_format = '';
+
+	/**
+	 * @type string $_pretty_date_format
+	 */
+	protected $_pretty_date_format = '';
+
+	/**
+	 * @type string $_pretty_time_format
+	 */
+	protected $_pretty_time_format = '';
+
+	/**
+	 * @type DateTimeZone $_DateTimeZone
+	 */
+	protected $_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_UTC_DateTimeZone
+	 */
+	protected $_UTC_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_blog_DateTimeZone
+	 */
+	protected $_blog_DateTimeZone;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var string
+	 */
+	protected $_date_time_output = '';
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
+	 *
+	 * @var string
+	 */
+	protected $_timezone_string;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected $_blog_offset;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @param string $timezone_string
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param string $pretty_date_format
+	 * @param string $pretty_time_format
+	 */
+	public function __construct(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		string $default_value,
+		string $timezone_string = '',
+		string $date_format = '',
+		string $time_format = '',
+		string $pretty_date_format = '',
+		string $pretty_time_format = ''
+	) {
+
+		$this->_date_format        = ! empty($date_format)
+			? $date_format
+			: get_option('date_format');
+		$this->_time_format        = ! empty($time_format)
+			? $time_format
+			: get_option('time_format');
+		$this->_pretty_date_format = ! empty($pretty_date_format)
+			? $pretty_date_format
+			: get_option('date_format');
+		$this->_pretty_time_format = ! empty($pretty_time_format)
+			? $pretty_time_format
+			: get_option('time_format');
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaFormat('date-time');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 */
+	public function get_UTC_DateTimeZone(): DateTimeZone
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 */
+	public function get_blog_DateTimeZone(): DateTimeZone
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string();
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
+	 *
+	 * @param string|int $value_inputted_for_field_on_model_object  could be a string formatted date time or int unix
+	 *                                                              timestamp
+	 * @return DateTime
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output(bool $pretty = false): string
+	{
+		$pretty = filter_var($pretty, FILTER_VALIDATE_BOOLEAN);
+		switch ($this->_date_time_output) {
+			case 'time':
+				return $pretty
+					? $this->_pretty_time_format
+					: $this->_time_format;
+
+			case 'date':
+				return $pretty
+					? $this->_pretty_date_format
+					: $this->_date_format;
+
+			default:
+				return $pretty
+					? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
+					: $this->_date_format . ' ' . $this->_time_format;
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string $what acceptable values are 'time' or 'date'.
+	 *                     Any other value will be set but will always result
+	 *                     in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output(string $what = '')
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string $timezone_string A valid timezone string as described by @link
+	 *                                http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set_timezone(string $timezone_string)
+	{
+		if (empty($timezone_string) && ! empty($this->_timezone_string)) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @param string $timezone_string
+	 * @return DateTimeZone
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_timezone_object_from_timezone_string(string $timezone_string = ''): DateTimeZone
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @return string timezone string
+	 */
+	public function get_timezone(): string
+	{
+		return $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = $format;
+		} else {
+			$this->_date_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_date_format
+			: $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = $format;
+		} else {
+			$this->_time_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_time_format
+			: $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format(string $format)
+	{
+		$this->_pretty_date_format = $format;
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format(string $format)
+	{
+		$this->_pretty_time_format = $format;
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = [
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = [
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
+	 * datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param DateTime $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws EE_Error
+	 */
+	public function prepare_for_get($DateTime): string
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param DateTime $DateTime
+	 * @param string $schema
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, string $schema = 'pretty'): string
+	{
+		return $this->_prepare_for_display($DateTime, $schema);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime $DateTime
+	 * @param string   $schema
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _prepare_for_display(DateTime $DateTime, string $schema = ''): string
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				} else {
+					$DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				}
+			}
+		}
+		$pretty = $schema === 'pretty';
+		$format_string = $this->_get_date_time_output($pretty);
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+
+		$timezone_string = '';
+		if ($this->_display_timezone()) {
+			// must be explicit because schema could equal true.
+			$timezone_string = $schema === 'no_html'
+				? ' (' . $DateTime->format('T') . ')'
+				: ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+		}
+		return $DateTime->format($format_string) . $timezone_string;
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime|null $datetime_value
+	 * @return string mysql timestamp in UTC
+	 * @throws EE_Error
+	 */
+	public function prepare_for_use_in_db($datetime_value)
+	{
+		// we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The incoming value being prepared for setting in the database must either be empty or a php 
             		    DateTime object, instead of: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    print_r($datetime_value, true)
-                )
-            );
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-            EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
-            return $datetime_value->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable && empty($datetime_value)
-            ? current_time('mysql', true)
-            : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
-     * @throws EE_Error
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        // if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        if (empty($datetime_string)) {
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        } else {
-            $DateTime = DbSafeDateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-        }
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws EE_Error
-     */
-    protected function _display_timezone()
-    {
-
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
-     *                                                    in the format that is set on the date_field (or DateTime
-     *                                                    object)!
-     * @return DateTime
-     */
-    protected function _get_date_object($date_string)
-    {
-        // first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        // not a unix timestamp.  So we will use the set format on this object and set timezone to
-        // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".',
-                                   'event_espresso'),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param DateTimeZone $DateTimeZone
-     * @param int          $time
-     * @param bool         $first_only
-     * @return mixed
-     */
-    public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
-    {
-        return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
-    }
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param DateTimeZone $DateTimeZone
-     * @param int          $time
-     * @return mixed
-     * @throws DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param string $timezone_string
-     * @return string           abbreviation
-     * @throws Exception
-     */
-    public function get_timezone_abbrev($timezone_string)
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-
-        return $dateTime->format('T');
-    }
-
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        } else {
-            return parent::get_default_value();
-        }
-    }
-
-
-    /**
-     * Gets the default datetime object from the field's default time
-     *
-     * @return DbSafeDateTime|null
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.66.p
-     */
-    public function getDefaultDateTimeObj()
-    {
-        $default_raw = $this->get_default_value();
-        if ($default_raw instanceof DateTime) {
-            return $default_raw;
-        } elseif (is_null($default_raw)) {
-            return $default_raw;
-        } else {
-            return new DbSafeDateTime(
-                $this->get_default_value(),
-                EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone())
-            );
-        }
-    }
-
-
-    public function getSchemaDescription()
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+						'event_espresso'
+					),
+					'<br />',
+					print_r($datetime_value, true)
+				)
+			);
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if (! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+			EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
+			return $datetime_value->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable && empty($datetime_value)
+			? current_time('mysql', true)
+			: null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  mixed null | DateTime
+	 * @throws EE_Error
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		// if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		if (empty($datetime_string)) {
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		} else {
+			$DateTime = DbSafeDateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+		}
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws EE_Error
+	 */
+	protected function _display_timezone()
+	{
+
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
+	 *                                                    in the format that is set on the date_field (or DateTime
+	 *                                                    object)!
+	 * @return DateTime
+	 */
+	protected function _get_date_object($date_string)
+	{
+		// first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		// not a unix timestamp.  So we will use the set format on this object and set timezone to
+		// create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".',
+								   'event_espresso'),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param DateTimeZone $DateTimeZone
+	 * @param int          $time
+	 * @param bool         $first_only
+	 * @return mixed
+	 */
+	public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
+	{
+		return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
+	}
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param DateTimeZone $DateTimeZone
+	 * @param int          $time
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param string $timezone_string
+	 * @return string           abbreviation
+	 * @throws Exception
+	 */
+	public function get_timezone_abbrev($timezone_string)
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+
+		return $dateTime->format('T');
+	}
+
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		} else {
+			return parent::get_default_value();
+		}
+	}
+
+
+	/**
+	 * Gets the default datetime object from the field's default time
+	 *
+	 * @return DbSafeDateTime|null
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.66.p
+	 */
+	public function getDefaultDateTimeObj()
+	{
+		$default_raw = $this->get_default_value();
+		if ($default_raw instanceof DateTime) {
+			return $default_raw;
+		} elseif (is_null($default_raw)) {
+			return $default_raw;
+		} else {
+			return new DbSafeDateTime(
+				$this->get_default_value(),
+				EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone())
+			);
+		}
+	}
+
+
+	public function getSchemaDescription()
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -218,8 +218,8 @@ 
 
             default:
                 return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
+                    ? $this->_pretty_date_format.' '.$this->_pretty_time_format
+                    : $this->_date_format.' '.$this->_time_format;
         }
     }
 
@@ -473,7 +473,7 @@ 
      */
     protected function _prepare_for_display(DateTime $DateTime, string $schema = ''): string
     {
-        if (! $DateTime instanceof DateTime) {
+        if ( ! $DateTime instanceof DateTime) {
             if ($this->_nullable) {
                 return '';
             } else {
@@ -509,10 +509,10 @@ 
         if ($this->_display_timezone()) {
             // must be explicit because schema could equal true.
             $timezone_string = $schema === 'no_html'
-                ? ' (' . $DateTime->format('T') . ')'
-                : ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+                ? ' ('.$DateTime->format('T').')'
+                : ' <span class="ee_dtt_timezone_string">('.$DateTime->format('T').')</span>';
         }
-        return $DateTime->format($format_string) . $timezone_string;
+        return $DateTime->format($format_string).$timezone_string;
     }
 
 
@@ -527,7 +527,7 @@ 
     public function prepare_for_use_in_db($datetime_value)
     {
         // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+        if ( ! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -542,7 +542,7 @@ 
         }
 
         if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
+            if ( ! $datetime_value instanceof DbSafeDateTime) {
                 $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
             }
             EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
@@ -583,7 +583,7 @@ 
             );
         }
 
-        if (! $DateTime instanceof DbSafeDateTime) {
+        if ( ! $DateTime instanceof DbSafeDateTime) {
             // if still no datetime object, then let's just use now
             $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
         }
@@ -660,10 +660,10 @@ 
         }
         // not a unix timestamp.  So we will use the set format on this object and set timezone to
         // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
+        $format = $this->_date_format.' '.$this->_time_format;
         try {
             $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
+            if ( ! $DateTime instanceof DbSafeDateTime) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('"%1$s" does not represent a valid Date Time in the format "%2$s".',

core/EE_Data_Mapper.core.php

Indentation +95 added lines, -95 removed lines

@@ -16,99 +16,99 @@
 {
 
 
-    /**
-     * instance of the EE_Data_Mapper Object
-     *
-     * @private _instance
-     */
-    private static $_instance;
-
-
-    public $data = array();
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     *@ singleton method used to instantiate class object
-     *@ access public
-     *@ return class instance
-     */
-    public function &instance()
-    {
-        // check if class object is instantiated
-        if (
-            self::$_instance === null
-            || ! is_object(self::$_instance)
-            || ! self::$_instance instanceof EE_Data_Mapper
-        ) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     *        @ override magic methods
-     *        @ return void
-     */
-    final public function __destruct()
-    {
-    }
-
-    final public function __call($a, $b)
-    {
-    }
-
-    public static function __callStatic($a, $b)
-    {
-    }
-
-    final public function __get($a)
-    {
-    }
-
-    final public function __set($a, $b)
-    {
-    }
-
-    final public function __isset($a)
-    {
-    }
-
-    final public function __unset($a)
-    {
-    }
-
-    final public function __sleep()
-    {
-        return array();
-    }
-
-    final public function __wakeup()
-    {
-    }
-
-    final public function __toString()
-    {
-        return '';
-    }
-
-    final public function __invoke()
-    {
-    }
-
-    final public function __clone()
-    {
-    }
+	/**
+	 * instance of the EE_Data_Mapper Object
+	 *
+	 * @private _instance
+	 */
+	private static $_instance;
+
+
+	public $data = array();
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 *@ singleton method used to instantiate class object
+	 *@ access public
+	 *@ return class instance
+	 */
+	public function &instance()
+	{
+		// check if class object is instantiated
+		if (
+			self::$_instance === null
+			|| ! is_object(self::$_instance)
+			|| ! self::$_instance instanceof EE_Data_Mapper
+		) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 *        @ override magic methods
+	 *        @ return void
+	 */
+	final public function __destruct()
+	{
+	}
+
+	final public function __call($a, $b)
+	{
+	}
+
+	public static function __callStatic($a, $b)
+	{
+	}
+
+	final public function __get($a)
+	{
+	}
+
+	final public function __set($a, $b)
+	{
+	}
+
+	final public function __isset($a)
+	{
+	}
+
+	final public function __unset($a)
+	{
+	}
+
+	final public function __sleep()
+	{
+		return array();
+	}
+
+	final public function __wakeup()
+	{
+	}
+
+	final public function __toString()
+	{
+		return '';
+	}
+
+	final public function __invoke()
+	{
+	}
+
+	final public function __clone()
+	{
+	}
 }

core/helpers/EEH_Autoloader.helper.php

Indentation +271 added lines, -271 removed lines

@@ -15,275 +15,275 @@
 {
 
 
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     */
-    private static $_instance;
-
-    /**
-     *   $_autoloaders
-     * @var array $_autoloaders
-     */
-    private static $_autoloaders;
-
-    /**
-     * set to "paths" to display autoloader class => path mappings
-     * set to "times" to display autoloader loading times
-     * set to "all" to display both
-     *
-     * @var string $debug
-     */
-    public static $debug = false;
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function __construct()
-    {
-        if (EEH_Autoloader::$_autoloaders === null) {
-            EEH_Autoloader::$_autoloaders = [];
-            $this->_register_custom_autoloaders();
-            spl_autoload_register([$this, 'espresso_autoloader']);
-        }
-    }
-
-
-    /**
-     * @return EEH_Autoloader
-     */
-    public static function instance(): EEH_Autoloader
-    {
-        // check if class object is instantiated
-        if (! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
-            EEH_Autoloader::$_instance = new EEH_Autoloader();
-        }
-        return EEH_Autoloader::$_instance;
-    }
-
-
-    /**
-     * @param   $class_name
-     * @return  void
-     * @internal  param string $class_name - simple class name ie: session
-     * @internal  param $className
-     */
-    public static function espresso_autoloader($class_name)
-    {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            require_once(EEH_Autoloader::$_autoloaders[ $class_name ]);
-        }
-    }
-
-
-    /**
-     * @param array | string $class_paths - array of key => value pairings between class names and paths
-     * @param bool           $read_check  true if we need to check whether the file is readable or not.
-     * @param bool           $debug       **deprecated**
-     * @throws EE_Error
-     */
-    public static function register_autoloader($class_paths, $read_check = true, $debug = false)
-    {
-        $class_paths = is_array($class_paths) ? $class_paths : [$class_paths];
-        foreach ($class_paths as $class => $path) {
-            // skip all files that are not PHP
-            if (substr($path, strlen($path) - 3) !== 'php') {
-                continue;
-            }
-            // don't give up! you gotta...
-            // get some class
-            if (empty($class)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'No Class name was specified while registering an autoloader for the following path: %s.',
-                            'event_espresso'
-                        ),
-                        $path
-                    )
-                );
-            }
-            // one day you will find the path young grasshopper
-            if (empty($path)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('No path was specified while registering an autoloader for the %s class.', 'event_espresso'),
-                        $class
-                    )
-                );
-            }
-            // is file readable ?
-            if ($read_check && ! is_readable($path)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                            'event_espresso'
-                        ),
-                        $class,
-                        $path
-                    )
-                );
-            }
-            if (! isset(EEH_Autoloader::$_autoloaders[ $class ])) {
-                EEH_Autoloader::$_autoloaders[ $class ] = str_replace(['/', '\\'], '/', $path);
-                if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
-                    EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function get_autoloaders(): array
-    {
-        return EEH_Autoloader::$_autoloaders;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function _register_custom_autoloaders()
-    {
-        EEH_Autoloader::$debug = '';
-        EEH_Autoloader::register_helpers_autoloaders();
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            Benchmark::displayResults();
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public static function register_helpers_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function register_form_sections_autoloaders()
-    {
-        // EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_display_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_filter_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_template_part_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_business_classes()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
-    }
-
-
-    /**
-     * Assumes all the files in this folder have the normal naming scheme (namely that their classname
-     * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
-     * If that's not the case, you'll need to improve this function or just use
-     * EEH_File::get_classname_from_filepath_with_standard_filename() directly. Yes this has to scan the directory for
-     * files, but it only does it once -- not on EACH time the autoloader is used
-     *
-     * @param string $folder name, with or without trailing /, doesn't matter
-     * @param bool   $recursive
-     * @param bool   $debug  **deprecated**
-     * @throws EE_Error
-     */
-    public static function register_autoloaders_for_each_file_in_folder(
-        string $folder,
-        bool $recursive = false,
-        bool $debug = false
-    ) {
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
-            Benchmark::startTimer(basename($folder));
-        }
-        // make sure last char is a /
-        $folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
-        $class_to_filepath_map = [];
-        $exclude = ['index'];
-        // get all the files in that folder that end in php
-        $filepaths = glob($folder . '*');
-
-        if (empty($filepaths)) {
-            return;
-        }
-
-        foreach ($filepaths as $filepath) {
-            if (substr($filepath, -4, 4) === '.php') {
-                $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
-                if (! in_array($class_name, $exclude)) {
-                    $class_to_filepath_map [ $class_name ] = $filepath;
-                }
-            } elseif ($recursive) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
-            }
-        }
-        // we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
-        EEH_Autoloader::register_autoloader($class_to_filepath_map, false, $debug);
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            Benchmark::stopTimer(basename($folder));
-        }
-    }
-
-
-    /**
-     * register additional autoloader based on variation of the classname for an existing autoloader
-     *
-     * @param string $class_name - simple class name ie: EE_Session
-     * @param string $alias      - variation on class name ie: EE_session, session, etc
-     */
-    public static function add_alias(string $class_name, string $alias)
-    {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            EEH_Autoloader::$_autoloaders[ $alias ] = EEH_Autoloader::$_autoloaders[ $class_name ];
-        }
-    }
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 *   $_autoloaders
+	 * @var array $_autoloaders
+	 */
+	private static $_autoloaders;
+
+	/**
+	 * set to "paths" to display autoloader class => path mappings
+	 * set to "times" to display autoloader loading times
+	 * set to "all" to display both
+	 *
+	 * @var string $debug
+	 */
+	public static $debug = false;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function __construct()
+	{
+		if (EEH_Autoloader::$_autoloaders === null) {
+			EEH_Autoloader::$_autoloaders = [];
+			$this->_register_custom_autoloaders();
+			spl_autoload_register([$this, 'espresso_autoloader']);
+		}
+	}
+
+
+	/**
+	 * @return EEH_Autoloader
+	 */
+	public static function instance(): EEH_Autoloader
+	{
+		// check if class object is instantiated
+		if (! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
+			EEH_Autoloader::$_instance = new EEH_Autoloader();
+		}
+		return EEH_Autoloader::$_instance;
+	}
+
+
+	/**
+	 * @param   $class_name
+	 * @return  void
+	 * @internal  param string $class_name - simple class name ie: session
+	 * @internal  param $className
+	 */
+	public static function espresso_autoloader($class_name)
+	{
+		if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
+			require_once(EEH_Autoloader::$_autoloaders[ $class_name ]);
+		}
+	}
+
+
+	/**
+	 * @param array | string $class_paths - array of key => value pairings between class names and paths
+	 * @param bool           $read_check  true if we need to check whether the file is readable or not.
+	 * @param bool           $debug       **deprecated**
+	 * @throws EE_Error
+	 */
+	public static function register_autoloader($class_paths, $read_check = true, $debug = false)
+	{
+		$class_paths = is_array($class_paths) ? $class_paths : [$class_paths];
+		foreach ($class_paths as $class => $path) {
+			// skip all files that are not PHP
+			if (substr($path, strlen($path) - 3) !== 'php') {
+				continue;
+			}
+			// don't give up! you gotta...
+			// get some class
+			if (empty($class)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'No Class name was specified while registering an autoloader for the following path: %s.',
+							'event_espresso'
+						),
+						$path
+					)
+				);
+			}
+			// one day you will find the path young grasshopper
+			if (empty($path)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('No path was specified while registering an autoloader for the %s class.', 'event_espresso'),
+						$class
+					)
+				);
+			}
+			// is file readable ?
+			if ($read_check && ! is_readable($path)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+							'event_espresso'
+						),
+						$class,
+						$path
+					)
+				);
+			}
+			if (! isset(EEH_Autoloader::$_autoloaders[ $class ])) {
+				EEH_Autoloader::$_autoloaders[ $class ] = str_replace(['/', '\\'], '/', $path);
+				if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
+					EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function get_autoloaders(): array
+	{
+		return EEH_Autoloader::$_autoloaders;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _register_custom_autoloaders()
+	{
+		EEH_Autoloader::$debug = '';
+		EEH_Autoloader::register_helpers_autoloaders();
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			Benchmark::displayResults();
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public static function register_helpers_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function register_form_sections_autoloaders()
+	{
+		// EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_display_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_filter_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_template_part_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_business_classes()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
+	}
+
+
+	/**
+	 * Assumes all the files in this folder have the normal naming scheme (namely that their classname
+	 * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
+	 * If that's not the case, you'll need to improve this function or just use
+	 * EEH_File::get_classname_from_filepath_with_standard_filename() directly. Yes this has to scan the directory for
+	 * files, but it only does it once -- not on EACH time the autoloader is used
+	 *
+	 * @param string $folder name, with or without trailing /, doesn't matter
+	 * @param bool   $recursive
+	 * @param bool   $debug  **deprecated**
+	 * @throws EE_Error
+	 */
+	public static function register_autoloaders_for_each_file_in_folder(
+		string $folder,
+		bool $recursive = false,
+		bool $debug = false
+	) {
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
+			Benchmark::startTimer(basename($folder));
+		}
+		// make sure last char is a /
+		$folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
+		$class_to_filepath_map = [];
+		$exclude = ['index'];
+		// get all the files in that folder that end in php
+		$filepaths = glob($folder . '*');
+
+		if (empty($filepaths)) {
+			return;
+		}
+
+		foreach ($filepaths as $filepath) {
+			if (substr($filepath, -4, 4) === '.php') {
+				$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
+				if (! in_array($class_name, $exclude)) {
+					$class_to_filepath_map [ $class_name ] = $filepath;
+				}
+			} elseif ($recursive) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
+			}
+		}
+		// we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
+		EEH_Autoloader::register_autoloader($class_to_filepath_map, false, $debug);
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			Benchmark::stopTimer(basename($folder));
+		}
+	}
+
+
+	/**
+	 * register additional autoloader based on variation of the classname for an existing autoloader
+	 *
+	 * @param string $class_name - simple class name ie: EE_Session
+	 * @param string $alias      - variation on class name ie: EE_session, session, etc
+	 */
+	public static function add_alias(string $class_name, string $alias)
+	{
+		if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
+			EEH_Autoloader::$_autoloaders[ $alias ] = EEH_Autoloader::$_autoloaders[ $class_name ];
+		}
+	}
 }

core/helpers/EEH_Form_Fields.helper.php

Indentation +1464 added lines, -1464 removed lines

@@ -29,1034 +29,1034 @@ 
 {
 
 
-    /**
-     *  Generates HTML for the forms used on admin pages
-     *
-     *
-     *  @static
-     *  @access public
-     *  @param  array $input_vars - array of input field details
-     *  format:
-     *  $template_form_fields['field-id'] = array(
-     *      'name' => 'name_attribute',
-     *      'label' => __('Field Label', 'event_espresso'), //or false
-     *      'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden', 'checkbox', 'wp_editor'
-     *      'type' => 'int', //what "type" the value is (i.e. string, int etc)
-     *      'required' => false, //boolean for whether the field is required
-     *      'validation' => true, //boolean, whether to validate the field (todo)
-     *      'value' => 'some_value_for_field', //what value is used for field
-     *      'format' => '%d', //what format the value is (%d, %f, or %s)
-     *      'db-col' => 'column_in_db' //used to indicate which column the field corresponds with in the db
-     *      'options' => optiona, optionb || array('value' => 'label', '') //if the input type is "select", this allows you to set the args for the different <option> tags.
-     *      'tabindex' => 1 //this allows you to set the tabindex for the field.
-     *      'append_content' => '' //this allows you to send in html content to append to the field.
-     *  )
-     *  @param  array $id - used for defining unique identifiers for the form.
-     *  @return string
-     *  @todo: at some point we can break this down into other static methods to abstract it a bit better.
-     */
-    public static function get_form_fields($input_vars = array(), $id = false)
-    {
-
-        if (empty($input_vars)) {
-            EE_Error::add_error(__('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // if you don't behave - this is what you're gonna get !!!
-        $close = true;
-        $output = '<ul>'; // this is for using built-in wp styles... watch carefully...
-
-        // cycle thru inputs
-        foreach ($input_vars as $input_key => $input_value) {
-            $defaults = array(
-                'name' => $input_key,
-                'label' => __('No label', 'event_espresso'),
-                'input' => 'hidden',
-                'type' => 'int',
-                'required' => false,
-                'validation' => true,
-                'value' => 'some_value_for_field',
-                'format' => '%d',
-                'db-col' => 'column_in_db',
-                'options' => array(),
-                'tabindex' => '',
-                'append_content' => ''
-                );
-
-            $input_value = wp_parse_args($input_value, $defaults);
-
-            // required fields get a *
-            $required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
-            // and the css class "required"
-            $css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
-            $styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
-
-            $field_id = ($id) ? $id . '-' . $input_key : $input_key;
-            $tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
-
-            // rows or cols?
-            $rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
-            $cols = isset($input_value['cols']) ? $input_value['cols'] : '80';
-
-            // any content?
-            $append_content = $input_value['append_content'];
-
-            $output .= (!$close) ? '<ul>' : '';
-            $output .= '<li>';
-
-            // what type of input are we dealing with ?
-            switch ($input_value['input']) {
-                // text inputs
-                case 'text':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
-                    break;
-
-                // dropdowns
-                case 'select':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
-
-                    if (is_array($input_value['options'])) {
-                        $options = $input_value['options'];
-                    } else {
-                        $options = explode(',', $input_value['options']);
-                    }
-
-                    foreach ($options as $key => $value) {
-                        $selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
-                        // $key = str_replace( ' ', '_', sanitize_key( $value ));
-                        $output .= "\n\t\t\t\t" . '<option ' . $selected . ' value="' . $key . '">' . $value . '</option>';
-                    }
-                    $output .= "\n\t\t\t" . '</select>';
-
-                    break;
-
-                case 'textarea':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="' . $rows . '" cols="' . $cols . '" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
-                    break;
-
-                case 'hidden':
-                    $close = false;
-                    $output .= "</li></ul>";
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
-                    break;
-
-                case 'checkbox':
-                    $checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
-                    break;
-
-                case 'wp_editor':
-                    $close = false;
-                    $editor_settings = array(
-                        'textarea_name' => $input_value['name'],
-                        'textarea_rows' => $rows,
-                        'editor_class' => $styles,
-                        'tabindex' => $input_value['tabindex']
-                    );
-                    $output .= '</li>';
-                    $output .= '</ul>';
-                    $output .= '<h4>' . $input_value['label'] . '</h4>';
-                    if ($append_content) {
-                        $output .= $append_content;
-                    }
-                    ob_start();
-                    wp_editor($input_value['value'], $field_id, $editor_settings);
-                    $editor = ob_get_contents();
-                    ob_end_clean();
-                    $output .= $editor;
-                    break;
-            }
-            if ($append_content && $input_value['input'] !== 'wp_editor') {
-                $output .= $append_content;
-            }
-                $output .= ($close) ? '</li>' : '';
-        } // end foreach( $input_vars as $input_key => $input_value )
-        $output .= ($close) ? '</ul>' : '';
-
-        return $output;
-    }
-
-    /**
-     * form_fields_array
-     * This utility function assembles form fields from a given structured array with field information.
-     * //TODO: This is an alternate generator that we may want to use instead.
-     *
-     * @param  array $fields structured array of fields to assemble in the following format:
-     * [field_name] => array(
-     *      ['label'] => 'label for field',
-     *      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select type of field you can indicated the labels for each option via this index
-     *      ['extra_desc'] => 'extra description for the field', //optional
-     *      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults to text
-     *      ['value'] => 'value that goes in the field', //(if multi then this is an array of values and the 'default' paramater will be used for what is selected)
-     *      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
-     *      ['class'] => 'name-of-class(es)-for-input',
-     *      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi select type of field you can indicate the css class for each option via this index.
-     *      ['id'] => 'css-id-for-input') //defaults to 'field_name'
-     *      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields generated are going to be used in a loop and you want to make sure that the field identifiers are unique from each other.
-     *      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types such as textarea to indicate cols/rows.
-     *      ['tabindex'] => '' //this allows you to set the tabindex for the field.
-     *      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally contain an array of arguments for the editor setup.
-     *
-     * @return array         an array of inputs for form indexed by field name, and in the following structure:
-     *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
-     */
-    public static function get_form_fields_array($fields)
-    {
-
-        $form_fields = array();
-        $fields = (array) $fields;
-
-        foreach ($fields as $field_name => $field_atts) {
-            // defaults:
-            $defaults = array(
-                'label' => '',
-                'labels' => '',
-                'extra_desc' => '',
-                'type' => 'text',
-                'value' => '',
-                'default' => '',
-                'class' => '',
-                'classes' => '',
-                'id' => $field_name,
-                'unique_id' => '',
-                'dimensions' => array('10', '5'),
-                'tabindex' => '',
-                'wpeditor_args' => array()
-                );
-            // merge defaults with passed arguments
-            $_fields = wp_parse_args($field_atts, $defaults);
-            extract($_fields);
-            // generate label
-            $label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
-            // generate field name
-            $f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
-
-            // tabindex
-            $tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
-
-            // we determine what we're building based on the type
-            switch ($type) {
-                case 'textarea':
-                        $fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
-                        $fld .= $extra_desc;
-                    break;
-
-                case 'checkbox':
-                        $c_input = '';
-                    if (is_array($value)) {
-                        foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
-                        }
-                        $fld = $c_input;
-                    } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
-                    }
-                    break;
-
-                case 'radio':
-                        $c_input = '';
-                    if (is_array($value)) {
-                        foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
-                        }
-                        $fld = $c_input;
-                    } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
-                    }
-                    break;
-
-                case 'hidden':
-                        $fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
-                    break;
-
-                case 'select':
-                        $fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
-                    foreach ($value as $key => $val) {
-                        $checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
-                        $fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
-                    }
-                        $fld .= '</select>';
-                    break;
-
-                case 'wp_editor':
-                        $editor_settings = array(
-                            'textarea_name' => $f_name,
-                            'textarea_rows' => $dimensions[1],
-                            'editor_class' => $class,
-                            'tabindex' => $tabindex
-                            );
-                        $editor_settings = array_merge($wpeditor_args, $editor_settings);
-                        ob_start();
-                        wp_editor($value, $id, $editor_settings);
-                        $editor = ob_get_contents();
-                        ob_end_clean();
-                        $fld = $editor;
-                    break;
-
-                default: // 'text fields'
-                        $fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
-                        $fld .= $extra_desc;
-            }
-
-            $form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
-        }
-
-        return $form_fields;
-    }
-
-
-
-
-
-
-    /**
-     * espresso admin page select_input
-     * Turns an array into a select fields
-     *
-     * @static
-     * @access public
-     * @param  string  $name       field name
-     * @param  array  $values     option values, numbered array starting at 0, where each value is an array with a key 'text' (meaning text to display' and 'id' (meaning the internal value)
-     * eg: array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or as an array of key-value pairs, where the key is to be used for the
-     * select input's name, and the value will be the text shown to the user.  Optionally you can also include an additional key of "class" which will add a specific class to the option for that value.
-     * @param  string  $default    default value
-     * @param  string  $parameters extra paramaters
-     * @param  string  $class      css class
-     * @param  boolean $autosize   whether to autosize the select or not
-     * @return string              html string for the select input
-     */
-    public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
-    {
-        // if $values was submitted in the wrong format, convert it over
-        if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
-            $converted_values = array();
-            foreach ($values as $id => $text) {
-                $converted_values[] = array('id' => $id,'text' => $text);
-            }
-            $values = $converted_values;
-        }
-
-        $field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
-        // Debug
-        // EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
-        }
-        if ($autosize) {
-            $size = 'med';
-            for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
-                        $size = 'wide';
-                    }
-                }
-            }
-        } else {
-            $size = '';
-        }
-
-        $field .= ' class="' . $class . ' ' . $size . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-
-        for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
-                $field .= ' selected = "selected"';
-            }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
-            }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
-        }
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-
-
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param string $question_groups
-     * @return string HTML
-     */
-    public static function generate_question_groups_html($question_groups = array(), $group_wrapper = 'fieldset')
-    {
-
-        $html = '';
-        $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        if (! empty($question_groups)) {
-            // EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
-                    // use fieldsets
-                    $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
-                    // group_name
-                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
-                    // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
-
-                    $html .= $before_question_group_questions;
-                    // loop thru questions
-                    foreach ($QSG['QSG_questions'] as $question) {
+	/**
+	 *  Generates HTML for the forms used on admin pages
+	 *
+	 *
+	 *  @static
+	 *  @access public
+	 *  @param  array $input_vars - array of input field details
+	 *  format:
+	 *  $template_form_fields['field-id'] = array(
+	 *      'name' => 'name_attribute',
+	 *      'label' => __('Field Label', 'event_espresso'), //or false
+	 *      'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden', 'checkbox', 'wp_editor'
+	 *      'type' => 'int', //what "type" the value is (i.e. string, int etc)
+	 *      'required' => false, //boolean for whether the field is required
+	 *      'validation' => true, //boolean, whether to validate the field (todo)
+	 *      'value' => 'some_value_for_field', //what value is used for field
+	 *      'format' => '%d', //what format the value is (%d, %f, or %s)
+	 *      'db-col' => 'column_in_db' //used to indicate which column the field corresponds with in the db
+	 *      'options' => optiona, optionb || array('value' => 'label', '') //if the input type is "select", this allows you to set the args for the different <option> tags.
+	 *      'tabindex' => 1 //this allows you to set the tabindex for the field.
+	 *      'append_content' => '' //this allows you to send in html content to append to the field.
+	 *  )
+	 *  @param  array $id - used for defining unique identifiers for the form.
+	 *  @return string
+	 *  @todo: at some point we can break this down into other static methods to abstract it a bit better.
+	 */
+	public static function get_form_fields($input_vars = array(), $id = false)
+	{
+
+		if (empty($input_vars)) {
+			EE_Error::add_error(__('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// if you don't behave - this is what you're gonna get !!!
+		$close = true;
+		$output = '<ul>'; // this is for using built-in wp styles... watch carefully...
+
+		// cycle thru inputs
+		foreach ($input_vars as $input_key => $input_value) {
+			$defaults = array(
+				'name' => $input_key,
+				'label' => __('No label', 'event_espresso'),
+				'input' => 'hidden',
+				'type' => 'int',
+				'required' => false,
+				'validation' => true,
+				'value' => 'some_value_for_field',
+				'format' => '%d',
+				'db-col' => 'column_in_db',
+				'options' => array(),
+				'tabindex' => '',
+				'append_content' => ''
+				);
+
+			$input_value = wp_parse_args($input_value, $defaults);
+
+			// required fields get a *
+			$required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
+			// and the css class "required"
+			$css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
+			$styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
+
+			$field_id = ($id) ? $id . '-' . $input_key : $input_key;
+			$tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
+
+			// rows or cols?
+			$rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
+			$cols = isset($input_value['cols']) ? $input_value['cols'] : '80';
+
+			// any content?
+			$append_content = $input_value['append_content'];
+
+			$output .= (!$close) ? '<ul>' : '';
+			$output .= '<li>';
+
+			// what type of input are we dealing with ?
+			switch ($input_value['input']) {
+				// text inputs
+				case 'text':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+					break;
+
+				// dropdowns
+				case 'select':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+
+					if (is_array($input_value['options'])) {
+						$options = $input_value['options'];
+					} else {
+						$options = explode(',', $input_value['options']);
+					}
+
+					foreach ($options as $key => $value) {
+						$selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
+						// $key = str_replace( ' ', '_', sanitize_key( $value ));
+						$output .= "\n\t\t\t\t" . '<option ' . $selected . ' value="' . $key . '">' . $value . '</option>';
+					}
+					$output .= "\n\t\t\t" . '</select>';
+
+					break;
+
+				case 'textarea':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="' . $rows . '" cols="' . $cols . '" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
+					break;
+
+				case 'hidden':
+					$close = false;
+					$output .= "</li></ul>";
+					$output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
+					break;
+
+				case 'checkbox':
+					$checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
+					break;
+
+				case 'wp_editor':
+					$close = false;
+					$editor_settings = array(
+						'textarea_name' => $input_value['name'],
+						'textarea_rows' => $rows,
+						'editor_class' => $styles,
+						'tabindex' => $input_value['tabindex']
+					);
+					$output .= '</li>';
+					$output .= '</ul>';
+					$output .= '<h4>' . $input_value['label'] . '</h4>';
+					if ($append_content) {
+						$output .= $append_content;
+					}
+					ob_start();
+					wp_editor($input_value['value'], $field_id, $editor_settings);
+					$editor = ob_get_contents();
+					ob_end_clean();
+					$output .= $editor;
+					break;
+			}
+			if ($append_content && $input_value['input'] !== 'wp_editor') {
+				$output .= $append_content;
+			}
+				$output .= ($close) ? '</li>' : '';
+		} // end foreach( $input_vars as $input_key => $input_value )
+		$output .= ($close) ? '</ul>' : '';
+
+		return $output;
+	}
+
+	/**
+	 * form_fields_array
+	 * This utility function assembles form fields from a given structured array with field information.
+	 * //TODO: This is an alternate generator that we may want to use instead.
+	 *
+	 * @param  array $fields structured array of fields to assemble in the following format:
+	 * [field_name] => array(
+	 *      ['label'] => 'label for field',
+	 *      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select type of field you can indicated the labels for each option via this index
+	 *      ['extra_desc'] => 'extra description for the field', //optional
+	 *      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults to text
+	 *      ['value'] => 'value that goes in the field', //(if multi then this is an array of values and the 'default' paramater will be used for what is selected)
+	 *      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
+	 *      ['class'] => 'name-of-class(es)-for-input',
+	 *      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi select type of field you can indicate the css class for each option via this index.
+	 *      ['id'] => 'css-id-for-input') //defaults to 'field_name'
+	 *      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields generated are going to be used in a loop and you want to make sure that the field identifiers are unique from each other.
+	 *      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types such as textarea to indicate cols/rows.
+	 *      ['tabindex'] => '' //this allows you to set the tabindex for the field.
+	 *      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally contain an array of arguments for the editor setup.
+	 *
+	 * @return array         an array of inputs for form indexed by field name, and in the following structure:
+	 *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
+	 */
+	public static function get_form_fields_array($fields)
+	{
+
+		$form_fields = array();
+		$fields = (array) $fields;
+
+		foreach ($fields as $field_name => $field_atts) {
+			// defaults:
+			$defaults = array(
+				'label' => '',
+				'labels' => '',
+				'extra_desc' => '',
+				'type' => 'text',
+				'value' => '',
+				'default' => '',
+				'class' => '',
+				'classes' => '',
+				'id' => $field_name,
+				'unique_id' => '',
+				'dimensions' => array('10', '5'),
+				'tabindex' => '',
+				'wpeditor_args' => array()
+				);
+			// merge defaults with passed arguments
+			$_fields = wp_parse_args($field_atts, $defaults);
+			extract($_fields);
+			// generate label
+			$label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
+			// generate field name
+			$f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+
+			// tabindex
+			$tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
+
+			// we determine what we're building based on the type
+			switch ($type) {
+				case 'textarea':
+						$fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
+						$fld .= $extra_desc;
+					break;
+
+				case 'checkbox':
+						$c_input = '';
+					if (is_array($value)) {
+						foreach ($value as $key => $val) {
+							$c_id = $field_name . '_' . $value;
+							$c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
+							$c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
+							$checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
+							$c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+						}
+						$fld = $c_input;
+					} else {
+						$checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
+						$fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+					}
+					break;
+
+				case 'radio':
+						$c_input = '';
+					if (is_array($value)) {
+						foreach ($value as $key => $val) {
+							$c_id = $field_name . '_' . $value;
+							$c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
+							$c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
+							$checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
+							$c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+						}
+						$fld = $c_input;
+					} else {
+						$checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
+						$fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+					}
+					break;
+
+				case 'hidden':
+						$fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
+					break;
+
+				case 'select':
+						$fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
+					foreach ($value as $key => $val) {
+						$checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
+						$fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
+					}
+						$fld .= '</select>';
+					break;
+
+				case 'wp_editor':
+						$editor_settings = array(
+							'textarea_name' => $f_name,
+							'textarea_rows' => $dimensions[1],
+							'editor_class' => $class,
+							'tabindex' => $tabindex
+							);
+						$editor_settings = array_merge($wpeditor_args, $editor_settings);
+						ob_start();
+						wp_editor($value, $id, $editor_settings);
+						$editor = ob_get_contents();
+						ob_end_clean();
+						$fld = $editor;
+					break;
+
+				default: // 'text fields'
+						$fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
+						$fld .= $extra_desc;
+			}
+
+			$form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
+		}
+
+		return $form_fields;
+	}
+
+
+
+
+
+
+	/**
+	 * espresso admin page select_input
+	 * Turns an array into a select fields
+	 *
+	 * @static
+	 * @access public
+	 * @param  string  $name       field name
+	 * @param  array  $values     option values, numbered array starting at 0, where each value is an array with a key 'text' (meaning text to display' and 'id' (meaning the internal value)
+	 * eg: array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or as an array of key-value pairs, where the key is to be used for the
+	 * select input's name, and the value will be the text shown to the user.  Optionally you can also include an additional key of "class" which will add a specific class to the option for that value.
+	 * @param  string  $default    default value
+	 * @param  string  $parameters extra paramaters
+	 * @param  string  $class      css class
+	 * @param  boolean $autosize   whether to autosize the select or not
+	 * @return string              html string for the select input
+	 */
+	public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
+	{
+		// if $values was submitted in the wrong format, convert it over
+		if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
+			$converted_values = array();
+			foreach ($values as $id => $text) {
+				$converted_values[] = array('id' => $id,'text' => $text);
+			}
+			$values = $converted_values;
+		}
+
+		$field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
+		// Debug
+		// EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		if (EEH_Formatter::ee_tep_not_null($parameters)) {
+			$field .= ' ' . $parameters;
+		}
+		if ($autosize) {
+			$size = 'med';
+			for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
+				if ($values[ $ii ]['text']) {
+					if (strlen($values[ $ii ]['text']) > 5) {
+						$size = 'wide';
+					}
+				}
+			}
+		} else {
+			$size = '';
+		}
+
+		$field .= ' class="' . $class . ' ' . $size . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+
+		for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
+			$field .= '<option value="' . $values[ $i ]['id'] . '"';
+			if ($default == $values[ $i ]['id']) {
+				$field .= ' selected = "selected"';
+			}
+			if (isset($values[ $i ]['class'])) {
+				$field .= ' class="' . $values[ $i ]['class'] . '"';
+			}
+			$field .= '>' . $values[ $i ]['text'] . '</option>';
+		}
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+
+
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param string $question_groups
+	 * @return string HTML
+	 */
+	public static function generate_question_groups_html($question_groups = array(), $group_wrapper = 'fieldset')
+	{
+
+		$html = '';
+		$before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		if (! empty($question_groups)) {
+			// EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				// check that questions exist
+				if (! empty($QSG['QSG_questions'])) {
+					// use fieldsets
+					$html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
+					// group_name
+					$html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
+					// group_desc
+					$html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
+
+					$html .= $before_question_group_questions;
+					// loop thru questions
+					foreach ($QSG['QSG_questions'] as $question) {
 //                      EEH_Debug_Tools::printr( $question, '$question  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                        $QFI = new EE_Question_Form_Input(
-                            $question['qst_obj'],
-                            $question['ans_obj'],
-                            $question
-                        );
-                        $html .= self::generate_form_input($QFI);
-                    }
-                    $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
-                }
-            }
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array         $question_groups
-     * @param array        $q_meta
-     * @param bool         $from_admin
-     * @param string       $group_wrapper
-     * @return string HTML
-     */
-    public static function generate_question_groups_html2($question_groups = array(), $q_meta = array(), $from_admin = false, $group_wrapper = 'fieldset')
-    {
-
-        $html = '';
-        $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        $default_q_meta = array(
-                'att_nmbr' => 1,
-                'ticket_id' => '',
-                'input_name' => '',
-                'input_id' => '',
-                'input_class' => ''
-        );
-        $q_meta = array_merge($default_q_meta, $q_meta);
-        // EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-
-        if (! empty($question_groups)) {
+						$QFI = new EE_Question_Form_Input(
+							$question['qst_obj'],
+							$question['ans_obj'],
+							$question
+						);
+						$html .= self::generate_form_input($QFI);
+					}
+					$html .= $after_question_group_questions;
+					$html .= "\n\t" . '</' . $group_wrapper . '>';
+				}
+			}
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array         $question_groups
+	 * @param array        $q_meta
+	 * @param bool         $from_admin
+	 * @param string       $group_wrapper
+	 * @return string HTML
+	 */
+	public static function generate_question_groups_html2($question_groups = array(), $q_meta = array(), $from_admin = false, $group_wrapper = 'fieldset')
+	{
+
+		$html = '';
+		$before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		$default_q_meta = array(
+				'att_nmbr' => 1,
+				'ticket_id' => '',
+				'input_name' => '',
+				'input_id' => '',
+				'input_class' => ''
+		);
+		$q_meta = array_merge($default_q_meta, $q_meta);
+		// EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+
+		if (! empty($question_groups)) {
 //          EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                if ($QSG instanceof EE_Question_Group) {
-                    // check that questions exist
-
-                    $where = array( 'QST_deleted' => 0 );
-                    if (! $from_admin) {
-                        $where['QST_admin_only'] = 0;
-                    }
-                    $questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
-                    if (! empty($questions)) {
-                        // use fieldsets
-                        $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
-                        // group_name
-                        if ($QSG->show_group_name()) {
-                            $html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
-                        }
-                        // group_desc
-                        if ($QSG->show_group_desc()) {
-                            $html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
-                        }
-
-                        $html .= $before_question_group_questions;
-                        // loop thru questions
-                        foreach ($questions as $QST) {
-                            $qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
-
-                            $answer = null;
-
-                            if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
-                                // check for answer in $_GET in case we are reprocessing a form after an error
-                                if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
-                                }
-                            } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
-                                // attendee data from the session
-                                $answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
-                            }
-
-
-
-                            $QFI = new EE_Question_Form_Input(
-                                $QST,
-                                EE_Answer::new_instance(array(
-                                            'ANS_ID' => 0,
-                                            'QST_ID' => 0,
-                                            'REG_ID' => 0,
-                                            'ANS_value' => $answer
-                                    )),
-                                $q_meta
-                            );
-                            // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                            $html .= self::generate_form_input($QFI);
-                        }
-                        $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
-                    }
-                }
-            }
-        }
-        return $html;
-    }
-
-
-
-
-
-
-    /**
-     * generate_form_input
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return string HTML
-     */
-    public static function generate_form_input(EE_Question_Form_Input $QFI)
-    {
-        if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
-            return '';
-        }
-
-        $QFI = self::_load_system_dropdowns($QFI);
-        $QFI = self::_load_specialized_dropdowns($QFI);
-
-        // we also need to verify
-
-        $display_text = $QFI->get('QST_display_text');
-        $input_name = $QFI->get('QST_input_name');
-        $answer = EE_Registry::instance()->REQ->is_set($input_name) ? EE_Registry::instance()->REQ->get($input_name) : $QFI->get('ANS_value');
-        $input_id = $QFI->get('QST_input_id');
-        $input_class = $QFI->get('QST_input_class');
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				if ($QSG instanceof EE_Question_Group) {
+					// check that questions exist
+
+					$where = array( 'QST_deleted' => 0 );
+					if (! $from_admin) {
+						$where['QST_admin_only'] = 0;
+					}
+					$questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
+					if (! empty($questions)) {
+						// use fieldsets
+						$html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
+						// group_name
+						if ($QSG->show_group_name()) {
+							$html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
+						}
+						// group_desc
+						if ($QSG->show_group_desc()) {
+							$html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
+						}
+
+						$html .= $before_question_group_questions;
+						// loop thru questions
+						foreach ($questions as $QST) {
+							$qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
+
+							$answer = null;
+
+							if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+								// check for answer in $_GET in case we are reprocessing a form after an error
+								if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
+									$answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
+								}
+							} elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
+								// attendee data from the session
+								$answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+							}
+
+
+
+							$QFI = new EE_Question_Form_Input(
+								$QST,
+								EE_Answer::new_instance(array(
+											'ANS_ID' => 0,
+											'QST_ID' => 0,
+											'REG_ID' => 0,
+											'ANS_value' => $answer
+									)),
+								$q_meta
+							);
+							// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+							$html .= self::generate_form_input($QFI);
+						}
+						$html .= $after_question_group_questions;
+						$html .= "\n\t" . '</' . $group_wrapper . '>';
+					}
+				}
+			}
+		}
+		return $html;
+	}
+
+
+
+
+
+
+	/**
+	 * generate_form_input
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return string HTML
+	 */
+	public static function generate_form_input(EE_Question_Form_Input $QFI)
+	{
+		if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
+			return '';
+		}
+
+		$QFI = self::_load_system_dropdowns($QFI);
+		$QFI = self::_load_specialized_dropdowns($QFI);
+
+		// we also need to verify
+
+		$display_text = $QFI->get('QST_display_text');
+		$input_name = $QFI->get('QST_input_name');
+		$answer = EE_Registry::instance()->REQ->is_set($input_name) ? EE_Registry::instance()->REQ->get($input_name) : $QFI->get('ANS_value');
+		$input_id = $QFI->get('QST_input_id');
+		$input_class = $QFI->get('QST_input_class');
 //      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
-        $disabled = $QFI->get('QST_disabled') ? true : false;
-        $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
-        $QST_required = $QFI->get('QST_required');
-        $required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
-        $use_html_entities = $QFI->get_meta('htmlentities');
-        $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
-        $required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
-        $label_class = 'espresso-form-input-lbl';
-        $QST_options = $QFI->options(true, $answer);
-        $options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
-        $system_ID = $QFI->get('QST_system');
-        $label_b4 = $QFI->get_meta('label_b4');
-        $use_desc_4_label = $QFI->get_meta('use_desc_4_label');
-
-
-        switch ($QFI->get('QST_type')) {
-            case 'TEXTAREA':
-                return EEH_Form_Fields::textarea($display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-
-            case 'DROPDOWN':
-                return EEH_Form_Fields::select($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, true);
-                break;
-
-
-            case 'RADIO_BTN':
-                return EEH_Form_Fields::radio($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label);
-                break;
-
-            case 'CHECKBOX':
-                return EEH_Form_Fields::checkbox($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities);
-                break;
-
-            case 'DATE':
-                return EEH_Form_Fields::datepicker($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-
-            case 'TEXT':
-            default:
-                return EEH_Form_Fields::text($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-        }
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form text input
-     *
-     * @param string $question  label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-    /**
-     * generates HTML for a form textarea
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $dimensions array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // make sure $dimensions is an array
-        $dimensions = is_array($dimensions) ? $dimensions : array();
-        // and set some defaults
-        $dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form select input
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param array $options            array of answer options where array key = option value and array value = option display text
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function select($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $add_please_select_option = false)
-    {
-
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? self::prep_answer(array_shift($answer), $use_html_entities) : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
-        // recursively count array elements, to determine total number of options
-        $only_option = count($options, 1) == 1 ? true : false;
-        if (! $only_option) {
-            // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected = $answer === null ? ' selected="selected"' : '';
-            $input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
-        }
-        foreach ($options as $key => $value) {
-            // if value is an array, then create option groups, else create regular ol' options
-            $input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
-        }
-
-        $input_html .= "\n\t\t\t" . '</select>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-    /**
-     *  _generate_select_option_group
-     *
-     *  if  $value for a select box is an array, then the key will be used as the optgroup label
-     *  and the value array will be looped thru and the elements sent to _generate_select_option
-     *
-     * @param mixed $opt_group
-     * @param mixed $QSOs
-     * @param mixed $answer
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
-    {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
-        foreach ($QSOs as $QSO) {
-            $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
-        }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
-        return $html;
-    }
-
-
-
-    /**
-     *  _generate_select_option
-     * @param mixed $key
-     * @param mixed $value
-     * @param mixed $answer
-     * @param int $only_option
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option($key, $value, $answer, $only_option = false, $use_html_entities = true)
-    {
-        $key = self::prep_answer($key, $use_html_entities);
-        $value = self::prep_answer($value, $use_html_entities);
-        $value = ! empty($value) ? $value : $key;
-        $selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
-        return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
-    }
-
-
-
-    /**
-     * generates HTML for form radio button inputs
-     *
-     * @param bool|string $question    label content
-     * @param string      $answer      form input value attribute
-     * @param array|bool  $options     array of answer options where array key = option value and array value = option display text
-     * @param bool|string $name        form input name attribute
-     * @param string      $id          form input css id attribute
-     * @param string      $class       form input css class attribute
-     * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string      $required_text
-     * @param string      $label_class css class attribute for the label
-     * @param bool|string $disabled    disabled="disabled" or null
-     * @param bool        $system_ID
-     * @param bool        $use_html_entities
-     * @param bool        $label_b4
-     * @param bool        $use_desc_4_label
-     * @return string HTML
-     */
-    public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
-    {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            if ($OPT instanceof EE_Question_Option) {
-                $value = self::prep_option_value($OPT->value());
-                $label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
-                $desc = $OPT->desc();// no self::prep_answer
-                $answer = is_numeric($value) && empty($answer) ? 0 : $answer;
-                $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
-            }
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for form checkbox inputs
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param array $options            array of options where array key = option value and array value = option display text
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        $answer = maybe_unserialize($answer);
-
-        // prep the answer(s)
-        $answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
-
-        foreach ($answer as $key => $value) {
-            $key = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
-        }
-
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class = empty($class) ? 'espresso-radio-btn-inp' : $class;
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
-            $text = self::prep_answer($OPT->value());
-            $desc = $OPT->desc() ;
-            $opt = '-' . sanitize_key($value);
-
-            $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
-
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
-            }
-            $input_html .= "\n\t\t\t\t" . '</li>';
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form datepicker input
-     *
-     * @param string $question  label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        // enqueue scripts
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('jquery-ui-datepicker');
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-    /**
-     *  remove_label_keep_required_msg
-     *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
-     *  @access public
-     *  @return     string
-     */
-    public static function remove_label_keep_required_msg($label_html, $required_text)
-    {
-        return $required_text;
-    }
-
-
-
-
-
-    /**
-     * Simply return sthe HTML for a hidden input of the given name and value.
-     * @param string $name
-     * @param string $value
-     * @return string HTML
-     */
-    public static function hidden_input($name, $value, $id = '')
-    {
-        $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' .  $value . '"/>';
-    }
-
-
-
-
-
-    /**
-     * prep_question
-     * @param string $question
-     * @return string
-     */
-    public static function prep_question($question)
-    {
-        return $question;
+		$disabled = $QFI->get('QST_disabled') ? true : false;
+		$required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
+		$QST_required = $QFI->get('QST_required');
+		$required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
+		$use_html_entities = $QFI->get_meta('htmlentities');
+		$required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
+		$required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
+		$label_class = 'espresso-form-input-lbl';
+		$QST_options = $QFI->options(true, $answer);
+		$options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
+		$system_ID = $QFI->get('QST_system');
+		$label_b4 = $QFI->get_meta('label_b4');
+		$use_desc_4_label = $QFI->get_meta('use_desc_4_label');
+
+
+		switch ($QFI->get('QST_type')) {
+			case 'TEXTAREA':
+				return EEH_Form_Fields::textarea($display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+
+			case 'DROPDOWN':
+				return EEH_Form_Fields::select($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, true);
+				break;
+
+
+			case 'RADIO_BTN':
+				return EEH_Form_Fields::radio($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label);
+				break;
+
+			case 'CHECKBOX':
+				return EEH_Form_Fields::checkbox($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities);
+				break;
+
+			case 'DATE':
+				return EEH_Form_Fields::datepicker($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+
+			case 'TEXT':
+			default:
+				return EEH_Form_Fields::text($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+		}
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form text input
+	 *
+	 * @param string $question  label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+	/**
+	 * generates HTML for a form textarea
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $dimensions array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// make sure $dimensions is an array
+		$dimensions = is_array($dimensions) ? $dimensions : array();
+		// and set some defaults
+		$dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form select input
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param array $options            array of answer options where array key = option value and array value = option display text
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function select($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $add_please_select_option = false)
+	{
+
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? self::prep_answer(array_shift($answer), $use_html_entities) : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+		// recursively count array elements, to determine total number of options
+		$only_option = count($options, 1) == 1 ? true : false;
+		if (! $only_option) {
+			// if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
+			$selected = $answer === null ? ' selected="selected"' : '';
+			$input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
+		}
+		foreach ($options as $key => $value) {
+			// if value is an array, then create option groups, else create regular ol' options
+			$input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
+		}
+
+		$input_html .= "\n\t\t\t" . '</select>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+	/**
+	 *  _generate_select_option_group
+	 *
+	 *  if  $value for a select box is an array, then the key will be used as the optgroup label
+	 *  and the value array will be looped thru and the elements sent to _generate_select_option
+	 *
+	 * @param mixed $opt_group
+	 * @param mixed $QSOs
+	 * @param mixed $answer
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
+	{
+		$html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+		foreach ($QSOs as $QSO) {
+			$html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
+		}
+		$html .= "\n\t\t\t\t" . '</optgroup>';
+		return $html;
+	}
+
+
+
+	/**
+	 *  _generate_select_option
+	 * @param mixed $key
+	 * @param mixed $value
+	 * @param mixed $answer
+	 * @param int $only_option
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option($key, $value, $answer, $only_option = false, $use_html_entities = true)
+	{
+		$key = self::prep_answer($key, $use_html_entities);
+		$value = self::prep_answer($value, $use_html_entities);
+		$value = ! empty($value) ? $value : $key;
+		$selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
+		return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
+	}
+
+
+
+	/**
+	 * generates HTML for form radio button inputs
+	 *
+	 * @param bool|string $question    label content
+	 * @param string      $answer      form input value attribute
+	 * @param array|bool  $options     array of answer options where array key = option value and array value = option display text
+	 * @param bool|string $name        form input name attribute
+	 * @param string      $id          form input css id attribute
+	 * @param string      $class       form input css class attribute
+	 * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string      $required_text
+	 * @param string      $label_class css class attribute for the label
+	 * @param bool|string $disabled    disabled="disabled" or null
+	 * @param bool        $system_ID
+	 * @param bool        $use_html_entities
+	 * @param bool        $label_b4
+	 * @param bool        $use_desc_4_label
+	 * @return string HTML
+	 */
+	public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
+	{
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			if ($OPT instanceof EE_Question_Option) {
+				$value = self::prep_option_value($OPT->value());
+				$label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
+				$size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
+				$desc = $OPT->desc();// no self::prep_answer
+				$answer = is_numeric($value) && empty($answer) ? 0 : $answer;
+				$checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
+				$opt = '-' . sanitize_key($value);
+
+				$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+				$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
+				$input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t" . '</label>';
+				$input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
+				$input_html .= "\n\t\t\t\t" . '</li>';
+			}
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for form checkbox inputs
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param array $options            array of options where array key = option value and array value = option display text
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		$answer = maybe_unserialize($answer);
+
+		// prep the answer(s)
+		$answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
+
+		foreach ($answer as $key => $value) {
+			$key = self::prep_option_value($key);
+			$answer[ $key ] = self::prep_answer($value, $use_html_entities);
+		}
+
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class = empty($class) ? 'espresso-radio-btn-inp' : $class;
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			$value = $OPT->value();// self::prep_option_value( $OPT->value() );
+			$size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+			$text = self::prep_answer($OPT->value());
+			$desc = $OPT->desc() ;
+			$opt = '-' . sanitize_key($value);
+
+			$checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
+
+			$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+			$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
+			$input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t" . '</label>';
+			if (! empty($desc) && $desc != $text) {
+				$input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
+			}
+			$input_html .= "\n\t\t\t\t" . '</li>';
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form datepicker input
+	 *
+	 * @param string $question  label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		// enqueue scripts
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('jquery-ui-datepicker');
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+	/**
+	 *  remove_label_keep_required_msg
+	 *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
+	 *  @access public
+	 *  @return     string
+	 */
+	public static function remove_label_keep_required_msg($label_html, $required_text)
+	{
+		return $required_text;
+	}
+
+
+
+
+
+	/**
+	 * Simply return sthe HTML for a hidden input of the given name and value.
+	 * @param string $name
+	 * @param string $value
+	 * @return string HTML
+	 */
+	public static function hidden_input($name, $value, $id = '')
+	{
+		$id = ! empty($id) ? $id : $name;
+		return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' .  $value . '"/>';
+	}
+
+
+
+
+
+	/**
+	 * prep_question
+	 * @param string $question
+	 * @return string
+	 */
+	public static function prep_question($question)
+	{
+		return $question;
 //      $link = '';
 //      // does this label have a help link attached ?
 //      if ( strpos( $question, '<a ' ) !== FALSE ) {
@@ -1068,449 +1068,449 @@ 
 //          $link = '<a ' . $link;
 //      }
 //      return htmlspecialchars( trim( stripslashes( str_replace( '&#039;', "'", $question ))), ENT_QUOTES, 'UTF-8' ) . ' ' . $link;
-    }
-
-
-
-
-    /**
-     *  prep_answer
-     * @param mixed $answer
-     * @return string
-     */
-    public static function prep_answer($answer, $use_html_entities = true)
-    {
-        // make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired, we want "0".
-        if (is_bool($answer)) {
-            $answer = $answer ? 1 : 0;
-        }
-        $answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
-        return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
-    }
-
-
-
-    /**
-     *  prep_answer_options
-     *  @param array $QSOs  array of EE_Question_Option objects
-     *  @return array
-     */
-    public static function prep_answer_options($QSOs = array())
-    {
-        $prepped_answer_options = array();
-        if (is_array($QSOs) && ! empty($QSOs)) {
-            foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
-                    $QSO = EE_Question_Option::new_instance(array(
-                        'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
-                        'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
-                    ));
-                }
-                if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
-                } else {
-                    $prepped_answer_options[] = $QSO;
-                }
-            }
-        }
+	}
+
+
+
+
+	/**
+	 *  prep_answer
+	 * @param mixed $answer
+	 * @return string
+	 */
+	public static function prep_answer($answer, $use_html_entities = true)
+	{
+		// make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired, we want "0".
+		if (is_bool($answer)) {
+			$answer = $answer ? 1 : 0;
+		}
+		$answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
+		return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
+	}
+
+
+
+	/**
+	 *  prep_answer_options
+	 *  @param array $QSOs  array of EE_Question_Option objects
+	 *  @return array
+	 */
+	public static function prep_answer_options($QSOs = array())
+	{
+		$prepped_answer_options = array();
+		if (is_array($QSOs) && ! empty($QSOs)) {
+			foreach ($QSOs as $key => $QSO) {
+				if (! $QSO instanceof EE_Question_Option) {
+					$QSO = EE_Question_Option::new_instance(array(
+						'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
+						'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
+					));
+				}
+				if ($QSO->opt_group()) {
+					$prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+				} else {
+					$prepped_answer_options[] = $QSO;
+				}
+			}
+		}
 //      d( $prepped_answer_options );
-        return $prepped_answer_options;
-    }
-
-
-    /**
-     *  prep_option_value
-     * @param string $option_value
-     * @return string
-     */
-    public static function prep_option_value($option_value)
-    {
-        return esc_attr(trim(stripslashes($option_value)));
-    }
-
-
-
-
-    /**
-     *  prep_required
-     * @param string|array  $required
-     * @return array
-     */
-    public static function prep_required($required = array())
-    {
-        // make sure required is an array
-        $required = is_array($required) ? $required : array();
-        // and set some defaults
-        $required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
-        return $required;
-    }
-
-
-
-    /**
-     *  get_label_size_class
-     * @param string    $value
-     * @return string
-     */
-    public static function get_label_size_class($value = false)
-    {
-        if ($value === false || $value == '') {
-            return ' class="medium-lbl"';
-        }
-            // determine length of option value
-            $val_size = strlen($value);
-        switch ($val_size) {
-            case $val_size < 3:
-                $size =  ' class="nano-lbl"';
-                break;
-            case $val_size < 6:
-                $size =  ' class="micro-lbl"';
-                break;
-            case $val_size < 12:
-                $size =  ' class="tiny-lbl"';
-                break;
-            case $val_size < 25:
-                $size =  ' class="small-lbl"';
-                break;
-            case $val_size > 100:
-                $size =  ' class="big-lbl"';
-                break;
-            default:
-                $size =  ' class="medium-lbl"';
-                break;
-        }
-        return $size;
-    }
-
-
-
-
-    /**
-     *  _load_system_dropdowns
-     * @param array     $QFI
-     * @return array
-     */
-    private static function _load_system_dropdowns($QFI)
-    {
-        $QST_system = $QFI->get('QST_system');
-        switch ($QST_system) {
-            case 'state':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'country':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-            case 'admin-state':
-                $QFI = self::generate_state_dropdown($QFI, true);
-                break;
-            case 'admin-country':
-                $QFI = self::generate_country_dropdown($QFI, true);
-                break;
-        }
-        return $QFI;
-    }
-
-
-
-    /**
-     * This preps dropdowns that are specialized.
-     *
-     * @since  4.6.0
-     *
-     * @param EE_Question_Form_Input $QFI
-     *
-     * @return EE_Question_Form_Input
-     */
-    protected static function _load_specialized_dropdowns($QFI)
-    {
-        switch ($QFI->get('QST_type')) {
-            case 'STATE':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'COUNTRY':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-        }
-        return $QFI;
-    }
-
-
-
-    /**
-     *    generate_state_dropdown
-     * @param array $QST
-     * @param bool  $get_all
-     * @return array
-     */
-    public static function generate_state_dropdown($QST, $get_all = false)
-    {
-        $states = $get_all
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_states_of_active_countries();
-        if (! empty($states) && count($states) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // if multiple countries, we'll create option groups within the dropdown
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(array (
-                        'QSO_value' => $state->ID(),
-                        'QSO_desc' => $state->name(),
-                        'QST_ID' => $QST->get('QST_ID'),
-                        'QSO_deleted' => false
-                    ));
-                    // set option group
-                    $QSO->set_opt_group($state->country()->name());
-                    // add option to question
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-
-    /**
-     *    generate_country_dropdown
-     * @param      $QST
-     * @param bool $get_all
-     * @internal param array $question
-     * @return array
-     */
-    public static function generate_country_dropdown($QST, $get_all = false)
-    {
-        $countries = $get_all ? EEM_Country::instance()->get_all_countries() : EEM_Country::instance()->get_all_active_countries();
-        if ($countries && count($countries) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // now add countries
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(array (
-                        'QSO_value' => $country->ID(),
-                        'QSO_desc' => $country->name(),
-                        'QST_ID' => $QST->get('QST_ID'),
-                        'QSO_deleted' => false
-                    ));
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-
-
-
-    /**
-     *  generates options for a month dropdown selector with numbers from 01 to 12
-     *  @return array()
-     */
-    public static function two_digit_months_dropdown_options()
-    {
-        $options = array();
-        for ($x = 1; $x <= 12; $x++) {
-            $mm = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $mm ] = (string) $mm;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-
-
-
-    /**
-     *  generates a year dropdown selector with numbers for the next ten years
-     *  @return object
-     */
-    public static function next_decade_two_digit_year_dropdown_options()
-    {
-        $options = array();
-        $current_year = date('y');
-        $next_decade = $current_year + 10;
-        for ($x = $current_year; $x <= $next_decade; $x++) {
-            $yy = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $yy ] = (string) $yy;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-
-
-
-    /**
-     * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for list table filter.
-     * @param  string  $cur_date     any currently selected date can be entered here.
-     * @param  string  $status       Registration status
-     * @param  integer $evt_category Event Category ID if the Event Category filter is selected
-     * @return string                html
-     */
-    public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
-    {
-        $_where = array();
-        if (!empty($status)) {
-            $_where['STS_ID'] = $status;
-        }
-
-        if ($evt_category > 0) {
-            $_where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
-
-        $regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
-
-        // setup vals for select input helper
-        $options = array(
-            0 => array(
-                'text' => __('Select a Month/Year', 'event_espresso'),
-                'id' => ''
-                )
-            );
-
-        foreach ($regdtts as $regdtt) {
-            $date = $regdtt->reg_month . ' ' . $regdtt->reg_year;
-            $options[] = array(
-                'text' => $date,
-                'id' => $date
-                );
-        }
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-
-    /**
-     * generates a month/year dropdown selector for all events matching the given criteria
-     * Typically used for list table filter
-     * @param  string $cur_date          any currently selected date can be entered here.
-     * @param  string $status            "view" (i.e. all, today, month, draft)
-     * @param  int    $evt_category      category event belongs to
-     * @param  string $evt_active_status "upcoming", "expired", "active", or "inactive"
-     * @return string                    html
-     */
-    public static function generate_event_months_dropdown($cur_date = '', $status = '', $evt_category = '', $evt_active_status = '')
-    {
-        // determine what post_status our condition will have for the query.
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                $where['Event.status'] = array( 'NOT IN', array('trash') );
-                break;
-
-            case 'draft':
-                $where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
-
-            default:
-                $where['Event.status'] = $status;
-        }
-
-        // phpcs:enable
-
-        // categories?
-
+		return $prepped_answer_options;
+	}
+
+
+	/**
+	 *  prep_option_value
+	 * @param string $option_value
+	 * @return string
+	 */
+	public static function prep_option_value($option_value)
+	{
+		return esc_attr(trim(stripslashes($option_value)));
+	}
+
+
+
+
+	/**
+	 *  prep_required
+	 * @param string|array  $required
+	 * @return array
+	 */
+	public static function prep_required($required = array())
+	{
+		// make sure required is an array
+		$required = is_array($required) ? $required : array();
+		// and set some defaults
+		$required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
+		return $required;
+	}
+
+
+
+	/**
+	 *  get_label_size_class
+	 * @param string    $value
+	 * @return string
+	 */
+	public static function get_label_size_class($value = false)
+	{
+		if ($value === false || $value == '') {
+			return ' class="medium-lbl"';
+		}
+			// determine length of option value
+			$val_size = strlen($value);
+		switch ($val_size) {
+			case $val_size < 3:
+				$size =  ' class="nano-lbl"';
+				break;
+			case $val_size < 6:
+				$size =  ' class="micro-lbl"';
+				break;
+			case $val_size < 12:
+				$size =  ' class="tiny-lbl"';
+				break;
+			case $val_size < 25:
+				$size =  ' class="small-lbl"';
+				break;
+			case $val_size > 100:
+				$size =  ' class="big-lbl"';
+				break;
+			default:
+				$size =  ' class="medium-lbl"';
+				break;
+		}
+		return $size;
+	}
+
+
+
+
+	/**
+	 *  _load_system_dropdowns
+	 * @param array     $QFI
+	 * @return array
+	 */
+	private static function _load_system_dropdowns($QFI)
+	{
+		$QST_system = $QFI->get('QST_system');
+		switch ($QST_system) {
+			case 'state':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'country':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+			case 'admin-state':
+				$QFI = self::generate_state_dropdown($QFI, true);
+				break;
+			case 'admin-country':
+				$QFI = self::generate_country_dropdown($QFI, true);
+				break;
+		}
+		return $QFI;
+	}
+
+
+
+	/**
+	 * This preps dropdowns that are specialized.
+	 *
+	 * @since  4.6.0
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 *
+	 * @return EE_Question_Form_Input
+	 */
+	protected static function _load_specialized_dropdowns($QFI)
+	{
+		switch ($QFI->get('QST_type')) {
+			case 'STATE':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'COUNTRY':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+		}
+		return $QFI;
+	}
+
+
+
+	/**
+	 *    generate_state_dropdown
+	 * @param array $QST
+	 * @param bool  $get_all
+	 * @return array
+	 */
+	public static function generate_state_dropdown($QST, $get_all = false)
+	{
+		$states = $get_all
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_states_of_active_countries();
+		if (! empty($states) && count($states) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// if multiple countries, we'll create option groups within the dropdown
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$QSO = EE_Question_Option::new_instance(array (
+						'QSO_value' => $state->ID(),
+						'QSO_desc' => $state->name(),
+						'QST_ID' => $QST->get('QST_ID'),
+						'QSO_deleted' => false
+					));
+					// set option group
+					$QSO->set_opt_group($state->country()->name());
+					// add option to question
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+
+	/**
+	 *    generate_country_dropdown
+	 * @param      $QST
+	 * @param bool $get_all
+	 * @internal param array $question
+	 * @return array
+	 */
+	public static function generate_country_dropdown($QST, $get_all = false)
+	{
+		$countries = $get_all ? EEM_Country::instance()->get_all_countries() : EEM_Country::instance()->get_all_active_countries();
+		if ($countries && count($countries) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// now add countries
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$QSO = EE_Question_Option::new_instance(array (
+						'QSO_value' => $country->ID(),
+						'QSO_desc' => $country->name(),
+						'QST_ID' => $QST->get('QST_ID'),
+						'QSO_deleted' => false
+					));
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+
+
+
+	/**
+	 *  generates options for a month dropdown selector with numbers from 01 to 12
+	 *  @return array()
+	 */
+	public static function two_digit_months_dropdown_options()
+	{
+		$options = array();
+		for ($x = 1; $x <= 12; $x++) {
+			$mm = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ (string) $mm ] = (string) $mm;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+
+
+
+	/**
+	 *  generates a year dropdown selector with numbers for the next ten years
+	 *  @return object
+	 */
+	public static function next_decade_two_digit_year_dropdown_options()
+	{
+		$options = array();
+		$current_year = date('y');
+		$next_decade = $current_year + 10;
+		for ($x = $current_year; $x <= $next_decade; $x++) {
+			$yy = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ (string) $yy ] = (string) $yy;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+
+
+
+	/**
+	 * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for list table filter.
+	 * @param  string  $cur_date     any currently selected date can be entered here.
+	 * @param  string  $status       Registration status
+	 * @param  integer $evt_category Event Category ID if the Event Category filter is selected
+	 * @return string                html
+	 */
+	public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
+	{
+		$_where = array();
+		if (!empty($status)) {
+			$_where['STS_ID'] = $status;
+		}
+
+		if ($evt_category > 0) {
+			$_where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
+
+		$regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
+
+		// setup vals for select input helper
+		$options = array(
+			0 => array(
+				'text' => __('Select a Month/Year', 'event_espresso'),
+				'id' => ''
+				)
+			);
+
+		foreach ($regdtts as $regdtt) {
+			$date = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+			$options[] = array(
+				'text' => $date,
+				'id' => $date
+				);
+		}
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+
+	/**
+	 * generates a month/year dropdown selector for all events matching the given criteria
+	 * Typically used for list table filter
+	 * @param  string $cur_date          any currently selected date can be entered here.
+	 * @param  string $status            "view" (i.e. all, today, month, draft)
+	 * @param  int    $evt_category      category event belongs to
+	 * @param  string $evt_active_status "upcoming", "expired", "active", or "inactive"
+	 * @return string                    html
+	 */
+	public static function generate_event_months_dropdown($cur_date = '', $status = '', $evt_category = '', $evt_active_status = '')
+	{
+		// determine what post_status our condition will have for the query.
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				$where['Event.status'] = array( 'NOT IN', array('trash') );
+				break;
+
+			case 'draft':
+				$where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
+
+			default:
+				$where['Event.status'] = $status;
+		}
+
+		// phpcs:enable
+
+		// categories?
+
 
-        if (!empty($evt_category)) {
-            $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
+		if (!empty($evt_category)) {
+			$where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
 
 
 //      $where['DTT_is_primary'] = 1;
 
-        $DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status);
-
-        // let's setup vals for select input helper
-        $options = array(
-            0 => array(
-                'text' => __('Select a Month/Year', 'event_espresso'),
-                'id' => ""
-                )
-            );
-
-
-
-        // translate month and date
-        global $wp_locale;
-
-        foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
-            $options[] = array(
-                'text' => $localized_date,
-                'id' => $id
-                );
-        }
-
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-
-    /**
-     * generates the dropdown selector for event categories
-     * typically used as a filter on list tables.
-     * @param  integer $current_cat currently selected category
-     * @return string               html for dropdown
-     */
-    public static function generate_event_category_dropdown($current_cat = -1)
-    {
-        $categories = EEM_Term::instance()->get_all_ee_categories(true);
-        $options = array(
-            '0' => array(
-                'text' => __('All Categories', 'event_espresso'),
-                'id' => -1
-                )
-            );
-
-        // setup categories for dropdown
-        foreach ($categories as $category) {
-            $options[] = array(
-                'text' => $category->get('name'),
-                'id' => $category->ID()
-                );
-        }
-
-        return self::select_input('EVT_CAT', $options, $current_cat);
-    }
-
-
-
-    /**
-     *    generate a submit button with or without it's own microform
-     *    this is the only way to create buttons that are compatible across all themes
-     *
-     * @access    public
-     * @param    string   $url              - the form action
-     * @param    string   $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm" for the form
-     * @param    string   $class            - css classes (separated by spaces if more than one)
-     * @param    string   $text             - what appears on the button
-     * @param    string   $nonce_action     - if using nonces
-     * @param    bool|string $input_only       - whether to print form header and footer. TRUE returns the input without the form
-     * @param    string   $extra_attributes - any extra attributes that need to be attached to the form input
-     * @return    void
-     */
-    public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = false, $extra_attributes = '')
-    {
-        $btn = '';
-        if (empty($url) || empty($ID)) {
-            return $btn;
-        }
-        $text = ! empty($text) ? $text : __('Submit', 'event_espresso');
-        $btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
-            $btn_frm .= $btn;
-            $btn_frm .= '</form>';
-            $btn = $btn_frm;
-            unset($btn_frm);
-        }
-        return $btn;
-    }
+		$DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status);
+
+		// let's setup vals for select input helper
+		$options = array(
+			0 => array(
+				'text' => __('Select a Month/Year', 'event_espresso'),
+				'id' => ""
+				)
+			);
+
+
+
+		// translate month and date
+		global $wp_locale;
+
+		foreach ($DTTS as $DTT) {
+			$localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
+			$id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+			$options[] = array(
+				'text' => $localized_date,
+				'id' => $id
+				);
+		}
+
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+
+	/**
+	 * generates the dropdown selector for event categories
+	 * typically used as a filter on list tables.
+	 * @param  integer $current_cat currently selected category
+	 * @return string               html for dropdown
+	 */
+	public static function generate_event_category_dropdown($current_cat = -1)
+	{
+		$categories = EEM_Term::instance()->get_all_ee_categories(true);
+		$options = array(
+			'0' => array(
+				'text' => __('All Categories', 'event_espresso'),
+				'id' => -1
+				)
+			);
+
+		// setup categories for dropdown
+		foreach ($categories as $category) {
+			$options[] = array(
+				'text' => $category->get('name'),
+				'id' => $category->ID()
+				);
+		}
+
+		return self::select_input('EVT_CAT', $options, $current_cat);
+	}
+
+
+
+	/**
+	 *    generate a submit button with or without it's own microform
+	 *    this is the only way to create buttons that are compatible across all themes
+	 *
+	 * @access    public
+	 * @param    string   $url              - the form action
+	 * @param    string   $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm" for the form
+	 * @param    string   $class            - css classes (separated by spaces if more than one)
+	 * @param    string   $text             - what appears on the button
+	 * @param    string   $nonce_action     - if using nonces
+	 * @param    bool|string $input_only       - whether to print form header and footer. TRUE returns the input without the form
+	 * @param    string   $extra_attributes - any extra attributes that need to be attached to the form input
+	 * @return    void
+	 */
+	public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = false, $extra_attributes = '')
+	{
+		$btn = '';
+		if (empty($url) || empty($ID)) {
+			return $btn;
+		}
+		$text = ! empty($text) ? $text : __('Submit', 'event_espresso');
+		$btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
+		if (! $input_only) {
+			$btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+			$btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
+			$btn_frm .= $btn;
+			$btn_frm .= '</form>';
+			$btn = $btn_frm;
+			unset($btn_frm);
+		}
+		return $btn;
+	}
 }

Spacing +184 added lines, -184 removed lines

@@ -90,10 +90,10 @@ 
             $required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
             // and the css class "required"
             $css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
-            $styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
+            $styles = $input_value['required'] ? 'required '.$css_class : $css_class;
 
-            $field_id = ($id) ? $id . '-' . $input_key : $input_key;
-            $tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
+            $field_id = ($id) ? $id.'-'.$input_key : $input_key;
+            $tabindex = ! empty($input_value['tabindex']) ? ' tabindex="'.$input_value['tabindex'].'"' : '';
 
             // rows or cols?
             $rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
@@ -102,21 +102,21 @@ 
             // any content?
             $append_content = $input_value['append_content'];
 
-            $output .= (!$close) ? '<ul>' : '';
+            $output .= ( ! $close) ? '<ul>' : '';
             $output .= '<li>';
 
             // what type of input are we dealing with ?
             switch ($input_value['input']) {
                 // text inputs
                 case 'text':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" class="'.$styles.'" type="text" value="'.esc_textarea($input_value['value']).'" name="'.$input_value['name'].'"'.$tabindex.'>';
                     break;
 
                 // dropdowns
                 case 'select':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<select id="'.$field_id.'" class="'.$styles.'" name="'.$input_value['name'].'"'.$tabindex.'>';
 
                     if (is_array($input_value['options'])) {
                         $options = $input_value['options'];
@@ -127,27 +127,27 @@ 
                     foreach ($options as $key => $value) {
                         $selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
                         // $key = str_replace( ' ', '_', sanitize_key( $value ));
-                        $output .= "\n\t\t\t\t" . '<option ' . $selected . ' value="' . $key . '">' . $value . '</option>';
+                        $output .= "\n\t\t\t\t".'<option '.$selected.' value="'.$key.'">'.$value.'</option>';
                     }
-                    $output .= "\n\t\t\t" . '</select>';
+                    $output .= "\n\t\t\t".'</select>';
 
                     break;
 
                 case 'textarea':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="' . $rows . '" cols="' . $cols . '" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<textarea id="'.$field_id.'" class="'.$styles.'" rows="'.$rows.'" cols="'.$cols.'" name="'.$input_value['name'].'"'.$tabindex.'>'.esc_textarea($input_value['value']).'</textarea>';
                     break;
 
                 case 'hidden':
                     $close = false;
                     $output .= "</li></ul>";
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="hidden" name="'.$input_value['name'].'" value="'.$input_value['value'].'">';
                     break;
 
                 case 'checkbox':
-                    $checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
+                    $checked = ($input_value['value'] == 1) ? 'checked="checked"' : '';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="checkbox" name="'.$input_value['name'].'" value="1"'.$checked.$tabindex.' />';
                     break;
 
                 case 'wp_editor':
@@ -160,7 +160,7 @@ 
                     );
                     $output .= '</li>';
                     $output .= '</ul>';
-                    $output .= '<h4>' . $input_value['label'] . '</h4>';
+                    $output .= '<h4>'.$input_value['label'].'</h4>';
                     if ($append_content) {
                         $output .= $append_content;
                     }
@@ -232,17 +232,17 @@ 
             $_fields = wp_parse_args($field_atts, $defaults);
             extract($_fields);
             // generate label
-            $label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
+            $label = empty($label) ? '' : '<label for="'.$id.'">'.$label.'</label>';
             // generate field name
-            $f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+            $f_name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name;
 
             // tabindex
-            $tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
+            $tabindex_str = ! empty($tabindex) ? ' tabindex="'.$tabindex.'"' : '';
 
             // we determine what we're building based on the type
             switch ($type) {
                 case 'textarea':
-                        $fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
+                        $fld = '<textarea id="'.$id.'" class="'.$class.'" rows="'.$dimensions[1].'" cols="'.$dimensions[0].'" name="'.$f_name.'"'.$tabindex_str.'>'.$value.'</textarea>';
                         $fld .= $extra_desc;
                     break;
 
@@ -250,16 +250,16 @@ 
                         $c_input = '';
                     if (is_array($value)) {
                         foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+                            $c_id = $field_name.'_'.$value;
+                            $c_class = isset($classes[$key]) ? ' class="'.$classes[$key].'" ' : '';
+                            $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : '';
+                            $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : '';
+                            $c_input .= '<input name="'.$f_name.'[]" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label;
                         }
                         $fld = $c_input;
                     } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+                        $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : '';
+                        $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n";
                     }
                     break;
 
@@ -267,28 +267,28 @@ 
                         $c_input = '';
                     if (is_array($value)) {
                         foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+                            $c_id = $field_name.'_'.$value;
+                            $c_class = isset($classes[$key]) ? 'class="'.$classes[$key].'" ' : '';
+                            $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : '';
+                            $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : '';
+                            $c_input .= '<input name="'.$f_name.'" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label;
                         }
                         $fld = $c_input;
                     } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="' . $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+                        $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : '';
+                        $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n";
                     }
                     break;
 
                 case 'hidden':
-                        $fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
+                        $fld = '<input name="'.$f_name.'" type="hidden" id="'.$id.'" class="'.$class.'" value="'.$value.'" />'."\n";
                     break;
 
                 case 'select':
-                        $fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
+                        $fld = '<select name="'.$f_name.'" class="'.$class.'" id="'.$id.'"'.$tabindex_str.'>'."\n";
                     foreach ($value as $key => $val) {
-                        $checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
-                        $fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
+                        $checked = ! empty($default) && $default == $val ? ' selected="selected"' : '';
+                        $fld .= "\t".'<option value="'.$val.'"'.$checked.'>'.$labels[$key].'</option>'."\n";
                     }
                         $fld .= '</select>';
                     break;
@@ -309,11 +309,11 @@ 
                     break;
 
                 default: // 'text fields'
-                        $fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
+                        $fld = '<input name="'.$f_name.'" type="text" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$tabindex_str.' />'."\n";
                         $fld .= $extra_desc;
             }
 
-            $form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
+            $form_fields[$field_name] = array('label' => $label, 'field' => $fld);
         }
 
         return $form_fields;
@@ -343,25 +343,25 @@ 
     public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
     {
         // if $values was submitted in the wrong format, convert it over
-        if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
+        if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) {
             $converted_values = array();
             foreach ($values as $id => $text) {
-                $converted_values[] = array('id' => $id,'text' => $text);
+                $converted_values[] = array('id' => $id, 'text' => $text);
             }
             $values = $converted_values;
         }
 
-        $field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
+        $field = '<select id="'.EEH_Formatter::ee_tep_output_string($name).'" name="'.EEH_Formatter::ee_tep_output_string($name).'"';
         // Debug
         // EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
         if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
+            $field .= ' '.$parameters;
         }
         if ($autosize) {
             $size = 'med';
             for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
+                if ($values[$ii]['text']) {
+                    if (strlen($values[$ii]['text']) > 5) {
                         $size = 'wide';
                     }
                 }
@@ -370,22 +370,22 @@ 
             $size = '';
         }
 
-        $field .= ' class="' . $class . ' ' . $size . '">';
+        $field .= ' class="'.$class.' '.$size.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
 
         for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
+            $field .= '<option value="'.$values[$i]['id'].'"';
+            if ($default == $values[$i]['id']) {
                 $field .= ' selected = "selected"';
             }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
+            if (isset($values[$i]['class'])) {
+                $field .= ' class="'.$values[$i]['class'].'"';
             }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
+            $field .= '>'.$values[$i]['text'].'</option>';
         }
         $field .= '</select>';
 
@@ -410,18 +410,18 @@ 
         $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
         $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
+                if ( ! empty($QSG['QSG_questions'])) {
                     // use fieldsets
-                    $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
+                    $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG['QSG_identifier'].'">';
                     // group_name
-                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
+                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.self::prep_answer($QSG['QSG_name']).'</h5>' : '';
                     // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
+                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">'.self::prep_answer($QSG['QSG_desc']).'</div>' : '';
 
                     $html .= $before_question_group_questions;
                     // loop thru questions
@@ -435,7 +435,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -471,28 +471,28 @@ 
         $q_meta = array_merge($default_q_meta, $q_meta);
         // EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
 //          EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 if ($QSG instanceof EE_Question_Group) {
                     // check that questions exist
 
-                    $where = array( 'QST_deleted' => 0 );
-                    if (! $from_admin) {
+                    $where = array('QST_deleted' => 0);
+                    if ( ! $from_admin) {
                         $where['QST_admin_only'] = 0;
                     }
-                    $questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
-                    if (! empty($questions)) {
+                    $questions = $QSG->questions(array($where, 'order_by' => array('Question_Group_Question.QGQ_order' => 'ASC')));
+                    if ( ! empty($questions)) {
                         // use fieldsets
-                        $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
+                        $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG->get('QSG_identifier').'">';
                         // group_name
                         if ($QSG->show_group_name()) {
-                            $html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
+                            $html .= "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.$QSG->get_pretty('QSG_name').'</h5>';
                         }
                         // group_desc
                         if ($QSG->show_group_desc()) {
-                            $html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
+                            $html .= '<div class="espresso-question-group-desc-pg">'.$QSG->get_pretty('QSG_desc').'</div>';
                         }
 
                         $html .= $before_question_group_questions;
@@ -504,12 +504,12 @@ 
 
                             if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
                                 // check for answer in $_GET in case we are reprocessing a form after an error
-                                if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
+                                if (isset($_GET['qstn'][$q_meta['input_id']][$qstn_id])) {
+                                    $answer = is_array($_GET['qstn'][$q_meta['input_id']][$qstn_id]) ? $_GET['qstn'][$q_meta['input_id']][$qstn_id] : sanitize_text_field($_GET['qstn'][$q_meta['input_id']][$qstn_id]);
                                 }
                             } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
                                 // attendee data from the session
-                                $answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+                                $answer = isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : null;
                             }
 
 
@@ -528,7 +528,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -567,10 +567,10 @@ 
         $disabled = $QFI->get('QST_disabled') ? true : false;
         $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
         $QST_required = $QFI->get('QST_required');
-        $required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
+        $required = $QST_required ? array('label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required) : array();
         $use_html_entities = $QFI->get_meta('htmlentities');
         $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
-        $required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
+        $required_text = $QST_required ? "\n\t\t\t".'<div class="required-text hidden">'.self::prep_answer($required_text, $use_html_entities).'</div>' : '';
         $label_class = 'espresso-form-input-lbl';
         $QST_options = $QFI->options(true, $answer);
         $options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
@@ -629,7 +629,7 @@ 
     public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -637,21 +637,21 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+        $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" value="'.esc_attr($answer).'"  title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -675,7 +675,7 @@ 
     public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -685,23 +685,23 @@ 
         // make sure $dimensions is an array
         $dimensions = is_array($dimensions) ? $dimensions : array();
         // and set some defaults
-        $dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
+        $dimensions = array_merge(array('rows' => 3, 'cols' => 40), $dimensions);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
+        $input_html = "\n\t\t\t".'<textarea name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  title="'.$required['msg'].'" '.$disabled.' '.$extra.'>'.$answer.'</textarea>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -727,7 +727,7 @@ 
     {
 
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -735,36 +735,36 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+        $input_html = "\n\t\t\t".'<select name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" title="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>';
         // recursively count array elements, to determine total number of options
         $only_option = count($options, 1) == 1 ? true : false;
-        if (! $only_option) {
+        if ( ! $only_option) {
             // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
             $selected = $answer === null ? ' selected="selected"' : '';
-            $input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
+            $input_html .= $add_please_select_option ? "\n\t\t\t\t".'<option value=""'.$selected.'>'.__(' - please select - ', 'event_espresso').'</option>' : '';
         }
         foreach ($options as $key => $value) {
             // if value is an array, then create option groups, else create regular ol' options
             $input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -783,11 +783,11 @@ 
      */
     private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
     {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+        $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">';
         foreach ($QSOs as $QSO) {
             $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
         }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
+        $html .= "\n\t\t\t\t".'</optgroup>';
         return $html;
     }
 
@@ -807,8 +807,8 @@ 
         $key = self::prep_answer($key, $use_html_entities);
         $value = self::prep_answer($value, $use_html_entities);
         $value = ! empty($value) ? $value : $key;
-        $selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
-        return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
+        $selected = ($answer == $key || $only_option) ? ' selected="selected"' : '';
+        return "\n\t\t\t\t".'<option value="'.self::prep_option_value($key).'"'.$selected.'> '.$value.'&nbsp;&nbsp;&nbsp;</option>';
     }
 
 
@@ -835,7 +835,7 @@ 
     public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
     {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -843,46 +843,46 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
         $class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+        $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> ';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+        $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
             if ($OPT instanceof EE_Question_Option) {
                 $value = self::prep_option_value($OPT->value());
                 $label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
-                $desc = $OPT->desc();// no self::prep_answer
+                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value().' '.$OPT->desc()) : self::get_label_size_class($OPT->value());
+                $desc = $OPT->desc(); // no self::prep_answer
                 $answer = is_numeric($value) && empty($answer) ? 0 : $answer;
                 $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
+                $opt = '-'.sanitize_key($value);
+
+                $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+                $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">';
+                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>' : '';
+                $input_html .= "\n\t\t\t\t\t\t".'<input type="radio" name="'.$name.'" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+                $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span class="espresso-radio-btn-desc">'.$label.'</span>' : '';
+                $input_html .= "\n\t\t\t\t\t".'</label>';
+                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>';
+                $input_html .= "\n\t\t\t\t".'</li>';
             }
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -907,62 +907,62 @@ 
     public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         $answer = maybe_unserialize($answer);
 
         // prep the answer(s)
-        $answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
+        $answer = is_array($answer) ? $answer : array(sanitize_key($answer) => $answer);
 
         foreach ($answer as $key => $value) {
             $key = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
+            $answer[$key] = self::prep_answer($value, $use_html_entities);
         }
 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
         $class = empty($class) ? 'espresso-radio-btn-inp' : $class;
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+        $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> ';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+        $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+            $value = $OPT->value(); // self::prep_option_value( $OPT->value() );
+            $size = self::get_label_size_class($OPT->value().' '.$OPT->desc());
             $text = self::prep_answer($OPT->value());
-            $desc = $OPT->desc() ;
-            $opt = '-' . sanitize_key($value);
+            $desc = $OPT->desc();
+            $opt = '-'.sanitize_key($value);
 
             $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
 
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
+            $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+            $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">';
+            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t\t".'<input type="checkbox" name="'.$name.'['.$OPT->ID().']" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t".'</label>';
+            if ( ! empty($desc) && $desc != $text) {
+                $input_html .= "\n\t\t\t\t\t".' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'.$desc.'</div>';
             }
-            $input_html .= "\n\t\t\t\t" . '</li>';
+            $input_html .= "\n\t\t\t\t".'</li>';
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -986,7 +986,7 @@ 
     public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -994,26 +994,26 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+        $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         // enqueue scripts
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso-ui-theme');
         wp_enqueue_script('jquery-ui-datepicker');
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -1042,7 +1042,7 @@ 
     public static function hidden_input($name, $value, $id = '')
     {
         $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' .  $value . '"/>';
+        return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>';
     }
 
 
@@ -1100,14 +1100,14 @@ 
         $prepped_answer_options = array();
         if (is_array($QSOs) && ! empty($QSOs)) {
             foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
+                if ( ! $QSO instanceof EE_Question_Option) {
                     $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
                         'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
                     ));
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1141,7 +1141,7 @@ 
         // make sure required is an array
         $required = is_array($required) ? $required : array();
         // and set some defaults
-        $required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
+        $required = array_merge(array('label' => '', 'class' => '', 'msg' => ''), $required);
         return $required;
     }
 
@@ -1161,22 +1161,22 @@ 
             $val_size = strlen($value);
         switch ($val_size) {
             case $val_size < 3:
-                $size =  ' class="nano-lbl"';
+                $size = ' class="nano-lbl"';
                 break;
             case $val_size < 6:
-                $size =  ' class="micro-lbl"';
+                $size = ' class="micro-lbl"';
                 break;
             case $val_size < 12:
-                $size =  ' class="tiny-lbl"';
+                $size = ' class="tiny-lbl"';
                 break;
             case $val_size < 25:
-                $size =  ' class="small-lbl"';
+                $size = ' class="small-lbl"';
                 break;
             case $val_size > 100:
-                $size =  ' class="big-lbl"';
+                $size = ' class="big-lbl"';
                 break;
             default:
-                $size =  ' class="medium-lbl"';
+                $size = ' class="medium-lbl"';
                 break;
         }
         return $size;
@@ -1247,12 +1247,12 @@ 
         $states = $get_all
             ? EEM_State::instance()->get_all_states()
             : EEM_State::instance()->get_all_states_of_active_countries();
-        if (! empty($states) && count($states) != count($QST->options())) {
+        if ( ! empty($states) && count($states) != count($QST->options())) {
             $QST->set('QST_type', 'DROPDOWN');
             // if multiple countries, we'll create option groups within the dropdown
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(array (
+                    $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => $state->ID(),
                         'QSO_desc' => $state->name(),
                         'QST_ID' => $QST->get('QST_ID'),
@@ -1285,7 +1285,7 @@ 
             // now add countries
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(array (
+                    $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => $country->ID(),
                         'QSO_desc' => $country->name(),
                         'QST_ID' => $QST->get('QST_ID'),
@@ -1311,7 +1311,7 @@ 
         $options = array();
         for ($x = 1; $x <= 12; $x++) {
             $mm = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $mm ] = (string) $mm;
+            $options[(string) $mm] = (string) $mm;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1331,7 +1331,7 @@ 
         $next_decade = $current_year + 10;
         for ($x = $current_year; $x <= $next_decade; $x++) {
             $yy = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $yy ] = (string) $yy;
+            $options[(string) $yy] = (string) $yy;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1350,7 +1350,7 @@ 
     public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
     {
         $_where = array();
-        if (!empty($status)) {
+        if ( ! empty($status)) {
             $_where['STS_ID'] = $status;
         }
 
@@ -1369,7 +1369,7 @@ 
             );
 
         foreach ($regdtts as $regdtt) {
-            $date = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+            $date = $regdtt->reg_month.' '.$regdtt->reg_year;
             $options[] = array(
                 'text' => $date,
                 'id' => $date
@@ -1399,11 +1399,11 @@ 
             case 'today':
             case null:
             case 'all':
-                $where['Event.status'] = array( 'NOT IN', array('trash') );
+                $where['Event.status'] = array('NOT IN', array('trash'));
                 break;
 
             case 'draft':
-                $where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
+                $where['Event.status'] = array('IN', array('draft', 'auto-draft'));
 
             default:
                 $where['Event.status'] = $status;
@@ -1414,7 +1414,7 @@ 
         // categories?
 
 
-        if (!empty($evt_category)) {
+        if ( ! empty($evt_category)) {
             $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
             $where['Event.Term_Taxonomy.term_id'] = $evt_category;
         }
@@ -1438,8 +1438,8 @@ 
         global $wp_locale;
 
         foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+            $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year;
+            $id = $DTT->dtt_month.' '.$DTT->dtt_year;
             $options[] = array(
                 'text' => $localized_date,
                 'id' => $id
@@ -1502,10 +1502,10 @@ 
             return $btn;
         }
         $text = ! empty($text) ? $text : __('Submit', 'event_espresso');
-        $btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
+        $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" type="submit" value="'.$text.'" '.$extra_attributes.'/>';
+        if ( ! $input_only) {
+            $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">';
+            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', true, false) : '';
             $btn_frm .= $btn;
             $btn_frm .= '</form>';
             $btn = $btn_frm;

core/db_classes/EE_Import.class.php

Indentation +954 added lines, -954 removed lines

@@ -14,91 +14,91 @@ 
 class EE_Import implements ResettableInterface
 {
 
-    const do_insert = 'insert';
-    const do_update = 'update';
-    const do_nothing = 'nothing';
-
-
-    // instance of the EE_Import object
-    private static $_instance;
-
-    private static $_csv_array = array();
-
-    /**
-     *
-     * @var array of model names
-     */
-    private static $_model_list = array();
-
-    private static $_columns_to_save = array();
-
-    protected $_total_inserts = 0;
-    protected $_total_updates = 0;
-    protected $_total_insert_errors = 0;
-    protected $_total_update_errors = 0;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        $this->_total_inserts = 0;
-        $this->_total_updates = 0;
-        $this->_total_insert_errors = 0;
-        $this->_total_update_errors = 0;
-    }
-
-
-    /**
-     *    @ singleton method used to instantiate class object
-     *    @ access public
-     *
-     * @return EE_Import
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Resets the importer
-     *
-     * @return EE_Import
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *    @ generates HTML for a file upload input and form
-     *    @ access    public
-     *
-     * @param    string $title  - heading for the form
-     * @param    string $intro  - additional text explaing what to do
-     * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
-     * @param    string $action - EE Admin page route array "action" that form will direct to
-     * @param    string $type   - type of file to import
-     *                          @ return    string
-     */
-    public function upload_form($title, $intro, $form_url, $action, $type)
-    {
-
-        $form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
-
-        ob_start();
-        ?>
+	const do_insert = 'insert';
+	const do_update = 'update';
+	const do_nothing = 'nothing';
+
+
+	// instance of the EE_Import object
+	private static $_instance;
+
+	private static $_csv_array = array();
+
+	/**
+	 *
+	 * @var array of model names
+	 */
+	private static $_model_list = array();
+
+	private static $_columns_to_save = array();
+
+	protected $_total_inserts = 0;
+	protected $_total_updates = 0;
+	protected $_total_insert_errors = 0;
+	protected $_total_update_errors = 0;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		$this->_total_inserts = 0;
+		$this->_total_updates = 0;
+		$this->_total_insert_errors = 0;
+		$this->_total_update_errors = 0;
+	}
+
+
+	/**
+	 *    @ singleton method used to instantiate class object
+	 *    @ access public
+	 *
+	 * @return EE_Import
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Resets the importer
+	 *
+	 * @return EE_Import
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *    @ generates HTML for a file upload input and form
+	 *    @ access    public
+	 *
+	 * @param    string $title  - heading for the form
+	 * @param    string $intro  - additional text explaing what to do
+	 * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
+	 * @param    string $action - EE Admin page route array "action" that form will direct to
+	 * @param    string $type   - type of file to import
+	 *                          @ return    string
+	 */
+	public function upload_form($title, $intro, $form_url, $action, $type)
+	{
+
+		$form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
+
+		ob_start();
+		?>
         <div class="ee-upload-form-dv">
             <h3><?php echo $title; ?></h3>
             <p><?php echo $intro; ?></p>
@@ -114,878 +114,878 @@ 
                 <b><?php _e('Attention', 'event_espresso'); ?></b><br/>
                 <?php echo sprintf(__('Accepts .%s file types only.', 'event_espresso'), $type); ?>
                 <?php echo __(
-                    'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
-                    'event_espresso'
-                ); ?>
+					'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
+					'event_espresso'
+				); ?>
             </p>
 
         </div>
 
         <?php
-        $uploader = ob_get_clean();
-        return $uploader;
-    }
-
-
-    /**
-     * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
-     * @access public
-     * @return boolean success
-     */
-    public function import()
-    {
-
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-
-        if (isset($_REQUEST['import'])) {
-            if (isset($_POST['csv_submitted'])) {
-                switch ($_FILES['file']['error'][0]) {
-                    case UPLOAD_ERR_OK:
-                        $error_msg = false;
-                        break;
-                    case UPLOAD_ERR_INI_SIZE:
-                        $error_msg = __(
-                            "'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_FORM_SIZE:
-                        $error_msg = __(
-                            'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_PARTIAL:
-                        $error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_FILE:
-                        $error_msg = __('No file was uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_TMP_DIR:
-                        $error_msg = __('Missing a temporary folder.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_CANT_WRITE:
-                        $error_msg = __('Failed to write file to disk.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_EXTENSION:
-                        $error_msg = __('File upload stopped by extension.', "event_espresso");
-                        break;
-                    default:
-                        $error_msg = __(
-                            'An unknown error occurred and the file could not be uploaded',
-                            "event_espresso"
-                        );
-                        break;
-                }
-
-                if (! $error_msg) {
-                    $filename = $_FILES['file']['name'][0];
-                    $file_ext = substr(strrchr($filename, '.'), 1);
-                    $file_type = $_FILES['file']['type'][0];
-                    $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
-
-                    if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
-                        if ($filesize < $max_upload || true) {
-                            $wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
-                            $path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
-
-                            if (move_uploaded_file($temp_file, $path_to_file)) {
-                                // convert csv to array
-                                $this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
-
-                                // was data successfully stored in an array?
-                                if (is_array($this->csv_array)) {
-                                    $import_what = str_replace('csv_import_', '', $_REQUEST['action']);
-                                    $import_what = str_replace('_', ' ', ucwords($import_what));
-                                    $processed_data = $this->csv_array;
-                                    $this->columns_to_save = false;
-
-                                    // if any imports require funcky processing, we'll catch them in the switch
-                                    switch ($_REQUEST['action']) {
-                                        case "import_events":
-                                        case "event_list":
-                                            $import_what = 'Event Details';
-                                            break;
-
-                                        case 'groupon_import_csv':
-                                            $import_what = 'Groupon Codes';
-                                            $processed_data = $this->process_groupon_codes();
-                                            break;
-                                    }
-                                    // save processed codes to db
-                                    if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
-                                        return true;
-                                    }
-                                } else {
-                                    // no array? must be an error
-                                    EE_Error::add_error(
-                                        sprintf(__("No file seems to have been uploaded", "event_espresso")),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    return false;
-                                }
-                            } else {
-                                EE_Error::add_error(
-                                    sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                        } else {
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        "%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
-                                        "event_espresso"
-                                    ),
-                                    $filename,
-                                    $max_upload
-                                ),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                            return false;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                }
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
-     *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
-     *    next level being numeric indexes adn each value representing a model object, and the last layer down
-     *    being keys of model fields and their proposed values.
-     *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
-     *    If the CSV data says (in the metadata row) that it's from the SAME database,
-     *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
-     *    IDs DON'T exist in the database, they're treated as temporary IDs,
-     *    which can used elsewhere to refer to the same object. Once an item
-     *    with a temporary ID gets inserted, we record its mapping from temporary
-     *    ID to real ID, and use the real ID in place of the temporary ID
-     *    when that temporary ID was used as a foreign key.
-     *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
-     *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
-     *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
-     *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
-     *    An important exception are non-auto-increment primary keys. If one entry in the
-     *    CSV file has the same ID as one in the DB, we assume they are meant to be
-     *    the same item, and instead update the item in the DB with that same ID.
-     *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
-     *    time you import a CSV from a different site, we remember their mappings, and
-     * will try to update the item in the DB instead of inserting another item (eg
-     * if we previously imported an event with temporary ID 1, and then it got a
-     * real ID of 123, we remember that. So the next time we import an event with
-     * temporary ID, from the same site, we know that it's real ID is 123, and will
-     * update that event, instead of adding a new event).
-     *
-     * @access public
-     * @param array $csv_data_array - the array containing the csv data produced from
-     *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
-    {
-        $success = false;
-        $error = false;
-        // whther to treat this import as if it's data froma different database or not
-        // ie, if it IS from a different database, ignore foreign keys whihf
-        $export_from_site_a_to_b = true;
-        // first level of array is not table information but a table name was passed to the function
-        // array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
-        if ($model_name) {
-            $csv_data_array = array($csv_data_array);
-        }
-        // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
-        $old_site_url = 'none-specified';
-        // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
-            // ok so its metadata, dont try to save it to ehte db obviously...
-            if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from the same database, so attempting to update data",
-                            "event_espresso"
-                        )
-                    )
-                );
-                $export_from_site_a_to_b = false;
-            } else {
-                $old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
-                            "event_espresso"
-                        ),
-                        $old_site_url,
-                        site_url()
-                    )
-                );
-            };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
-        }
-        /**
-         * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
-         * the value will be the newly-inserted ID.
-         * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
-         */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
-        if ($old_db_to_new_db_mapping) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        "We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
-                        "event_espresso"
-                    ),
-                    $old_site_url,
-                    site_url()
-                )
-            );
-        }
-        $old_db_to_new_db_mapping = $this->save_data_rows_to_db(
-            $csv_data_array,
-            $export_from_site_a_to_b,
-            $old_db_to_new_db_mapping
-        );
-
-        // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
-
-        if ($this->_total_updates > 0) {
-            EE_Error::add_success(
-                sprintf(
-                    __("%s existing records in the database were updated.", "event_espresso"),
-                    $this->_total_updates
-                )
-            );
-            $success = true;
-        }
-        if ($this->_total_inserts > 0) {
-            EE_Error::add_success(
-                sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
-            );
-            $success = true;
-        }
-
-        if ($this->_total_update_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_update_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-        if ($this->_total_insert_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_insert_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-
-        // lastly, we need to update the datetime and ticket sold amounts
-        // as those may have been affected by this
-        EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
-
-        // if there was at least one success and absolutely no errors
-        if ($success && ! $error) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Processes the array of data, given the knowledge that it's from the same database or a different one,
-     * and the mapping from temporary IDs to real IDs.
-     * If the data is from a different database, we treat the primary keys and their corresponding
-     * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
-     * in the real target database. As items are inserted, their temporary primary keys
-     * are mapped to the real IDs in the target database. Also, before doing any update or
-     * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
-     * An exception: string primary keys are treated as real IDs, or else we'd need to
-     * dynamically generate new string primary keys which would be very awkard for the country table etc.
-     * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
-     * combination of fields) to create a unique string identifying the row and store
-     * those in the mapping.
-     *
-     * If the data is from the same database, we usually treat primary keys as real IDs.
-     * An exception is if there is nothing in the database for that ID. If that's the case,
-     * we need to insert a new row for that ID, and then map from the non-existent ID
-     * to the newly-inserted real ID.
-     *
-     * @param type $csv_data_array
-     * @param type $export_from_site_a_to_b
-     * @param type $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
-    {
-        foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
-            // now check that assumption was correct. If
-            if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
-                $model_name = $model_name_in_csv_data;
-            } else {
-                // no table info in the array and no table name passed to the function?? FAIL
-                EE_Error::add_error(
-                    __(
-                        'No table information was specified and/or found, therefore the import could not be completed',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /* @var $model EEM_Base */
-            $model = EE_Registry::instance()->load_model($model_name);
-
-            // so without further ado, scanning all the data provided for primary keys and their inital values
-            foreach ($model_data_from_import as $model_object_data) {
-                // before we do ANYTHING, make sure the csv row wasn't just completely blank
-                $row_is_completely_empty = true;
-                foreach ($model_object_data as $field) {
-                    if ($field) {
-                        $row_is_completely_empty = false;
-                    }
-                }
-                if ($row_is_completely_empty) {
-                    continue;
-                }
-                // find the PK in the row of data (or a combined key if
-                // there is no primary key)
-                if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    $id_in_csv = $model->get_index_primary_key_string($model_object_data);
-                }
-
-
-                $model_object_data = $this->_replace_temp_ids_with_mappings(
-                    $model_object_data,
-                    $model,
-                    $old_db_to_new_db_mapping,
-                    $export_from_site_a_to_b
-                );
-                // now we need to decide if we're going to add a new model object given the $model_object_data,
-                // or just update.
-                if ($export_from_site_a_to_b) {
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {// this is just a re-import
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                }
-                if ($what_to_do == self::do_nothing) {
-                    continue;
-                }
-
-                // double-check we actually want to insert, if that's what we're planning
-                // based on whether this item would be unique in the DB or not
-                if ($what_to_do == self::do_insert) {
-                    // we're supposed to be inserting. But wait, will this thing
-                    // be acceptable if inserted?
-                    $conflicting = $model->get_one_conflicting($model_object_data, false);
-                    if ($conflicting) {
-                        // ok, this item would conflict if inserted. Just update the item that it conflicts with.
-                        $what_to_do = self::do_update;
-                        // and if this model has a primary key, remember its mapping
-                        if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
-                        } else {
-                            // we want to update this conflicting item, instead of inserting a conflicting item
-                            // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
-                            // for the WHERE conditions in the update). At the time of this comment, there were no models like this
-                            foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
-                                    $key_field->get_name()
-                                );
-                            }
-                        }
-                    }
-                }
-                if ($what_to_do == self::do_insert) {
-                    $old_db_to_new_db_mapping = $this->_insert_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } elseif ($what_to_do == self::do_update) {
-                    $old_db_to_new_db_mapping = $this->_update_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
-                                'event_espresso'
-                            ),
-                            $what_to_do
-                        )
-                    );
-                }
-            }
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Decides whether or not to insert, given that this data is from another database.
-     * So, if the primary key of this $model_object_data already exists in the database,
-     * it's just a coincidence and we should still insert. The only time we should
-     * update is when we know what it maps to, or there's something that would
-     * conflict (and we should instead just update that conflicting thing)
-     *
-     * @param string   $id_in_csv
-     * @param array    $model_object_data        by reference so it can be modified
-     * @param EEM_Base $model
-     * @param array    $old_db_to_new_db_mapping by reference so it can be modified
-     * @return string one of the consts on this class that starts with do_*
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
-        $id_in_csv,
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping
-    ) {
-        $model_name = $model->get_this_model_name();
-        // if it's a site-to-site export-and-import, see if this modelobject's id
-        // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * If this thing basically already exists in the database, we want to update it;
-     * otherwise insert it (ie, someone tweaked the CSV file, or the item was
-     * deleted in the database so it should be re-inserted)
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
-        $id_in_csv,
-        $model_object_data,
-        $model
-    ) {
-        // in this case, check if this thing ACTUALLY exists in the database
-        if ($model->get_one_conflicting($model_object_data)) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
-     * with their mapped real IDs. Eg, if importing from site A to B, the mapping
-     * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
-     * So this function searches for any event temp Ids called "my_event_id" and
-     * replaces them with 123.
-     * Also, if there is no temp ID for the INT foreign keys from another database,
-     * replaces them with 0 or the field's default.
-     *
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @param boolean  $export_from_site_a_to_b
-     * @return array updated model object data with temp IDs removed
-     */
-    protected function _replace_temp_ids_with_mappings(
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping,
-        $export_from_site_a_to_b
-    ) {
-        // if this model object's primary key is in the mapping, replace it
-        if (
-            $model->has_primary_key_field() &&
-            $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
-            isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
-            )
-        ) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
-        }
-
-        try {
-            $model_name_field = $model->get_field_containing_related_model_name();
-            $models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
-        } catch (EE_Error $e) {
-            $model_name_field = null;
-            $models_pointed_to_by_model_name_field = array();
-        }
-        foreach ($model->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
-                $models_pointed_to = $field_obj->get_model_names_pointed_to();
-                $found_a_mapping = false;
-                foreach ($models_pointed_to as $model_pointed_to_by_fk) {
-                    if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
-                        if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
-                                $model_pointed_to_by_fk,
-                                $old_db_to_new_db_mapping,
-                                $export_from_site_a_to_b
-                            );
-                            $found_a_mapping = true;
-                            break;
-                        }
-                    } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
-                            $model_pointed_to_by_fk,
-                            $old_db_to_new_db_mapping,
-                            $export_from_site_a_to_b
-                        );
-                        $found_a_mapping = true;
-                    }
-                    // once we've found a mapping for this field no need to continue
-                    if ($found_a_mapping) {
-                        break;
-                    }
-                }
-            } else {
-                // it's a string foreign key (which we leave alone, because those are things
-                // like country names, which we'd really rather not make 2 USAs etc (we'd actually
-                // prefer to just update one)
-                // or it's just a regular value that ought to be replaced
-            }
-        }
-        //
-        if ($model instanceof EEM_Term_Taxonomy) {
-            $model_object_data = $this->_handle_split_term_ids($model_object_data);
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
-     * this term-taxonomy refers to may be out-of-date so we need to update it.
-     * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
-     *
-     * @param type $model_object_data
-     * @return array new model object data
-     */
-    protected function _handle_split_term_ids($model_object_data)
-    {
-        if (
-            isset($model_object_data['term_id'])
-            && isset($model_object_data['taxonomy'])
-            && apply_filters(
-                'FHEE__EE_Import__handle_split_term_ids__function_exists',
-                function_exists('wp_get_split_term'),
-                $model_object_data
-            )
-        ) {
-            $new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
-            if ($new_term_id) {
-                $model_object_data['term_id'] = $new_term_id;
-            }
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * Given the object's ID and its model's name, find it int he mapping data,
-     * bearing in mind where it came from
-     *
-     * @param type   $object_id
-     * @param string $model_name
-     * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
-     * @return int
-     */
-    protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
-    {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
-        } elseif ($object_id == '0' || $object_id == '') {
-            // leave as-is
-            return $object_id;
-        } elseif ($export_from_site_a_to_b) {
-            // we couldn't find a mapping for this, and it's from a different site,
-            // so blank it out
-            return null;
-        } elseif (! $export_from_site_a_to_b) {
-            // we coudln't find a mapping for this, but it's from thsi DB anyway
-            // so let's just leave it as-is
-            return $object_id;
-        }
-    }
-
-    /**
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        // remove the primary key, if there is one (we don't want it for inserts OR updates)
-        // we'll put it back in if we need it
-        if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
-        } else {
-            $effective_id = $model->get_index_primary_key_string($model_object_data);
-        }
-        // the model takes care of validating the CSV's input
-        try {
-            $new_id = $model->insert($model_object_data);
-            if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
-                $this->_total_inserts++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        $new_id,
-                        implode(",", $model_object_data)
-                    )
-                );
-            } else {
-                $this->_total_insert_errors++;
-                // put the ID used back in there for the error message
-                if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        __("Could not insert new %s with the csv data: %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        http_build_query($model_object_data)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } catch (EE_Error $e) {
-            $this->_total_insert_errors++;
-            if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
-            }
-            EE_Error::add_error(
-                sprintf(
-                    __("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
-                    $model->get_this_model_name(),
-                    implode(",", $model_object_data),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Given the model object data, finds the row to update and updates it
-     *
-     * @param string|int $id_in_csv
-     * @param array      $model_object_data
-     * @param EEM_Base   $model
-     * @param array      $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        try {
-            // let's keep two copies of the model object data:
-            // one for performing an update, one for everthing else
-            $model_object_data_for_update = $model_object_data;
-            if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
-                // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
-            } elseif ($model->get_combined_primary_key_fields() > 1) {
-                $conditions = array();
-                foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
-                }
-            } else {
-                $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
-            }
-
-            $success = $model->update($model_object_data_for_update, array($conditions));
-            if ($success) {
-                $this->_total_updates++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully updated %s with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        implode(",", $model_object_data_for_update)
-                    )
-                );
-                // we should still record the mapping even though it was an update
-                // because if we were going to insert somethign but it was going to conflict
-                // we would have last-minute decided to update. So we'd like to know what we updated
-                // and so we record what record ended up being updated using the mapping
-                if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    // no primary key just a combined key
-                    $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
-                }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
-            } else {
-                $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
-                    // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
-                    $this->_total_update_errors++;
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                "Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            http_build_query($model_object_data),
-                            http_build_query($conditions)
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                } else {
-                    $this->_total_updates++;
-                    EE_Error::add_success(
-                        sprintf(
-                            __(
-                                "%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            implode(",", $model_object_data)
-                        )
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $this->_total_update_errors++;
-            $basic_message = sprintf(
-                __("Could not update %s with the csv data: %s because %s", "event_espresso"),
-                $model->get_this_model_name(),
-                implode(",", $model_object_data),
-                $e->getMessage()
-            );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
-            EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Gets the number of inserts performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_inserts()
-    {
-        return $this->_total_inserts;
-    }
-
-    /**
-     *  Gets the number of insert errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_insert_errors()
-    {
-        return $this->_total_insert_errors;
-    }
-
-    /**
-     *  Gets the number of updates performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_updates()
-    {
-        return $this->_total_updates;
-    }
-
-    /**
-     *  Gets the number of update errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_update_errors()
-    {
-        return $this->_total_update_errors;
-    }
+		$uploader = ob_get_clean();
+		return $uploader;
+	}
+
+
+	/**
+	 * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
+	 * @access public
+	 * @return boolean success
+	 */
+	public function import()
+	{
+
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+
+		if (isset($_REQUEST['import'])) {
+			if (isset($_POST['csv_submitted'])) {
+				switch ($_FILES['file']['error'][0]) {
+					case UPLOAD_ERR_OK:
+						$error_msg = false;
+						break;
+					case UPLOAD_ERR_INI_SIZE:
+						$error_msg = __(
+							"'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_FORM_SIZE:
+						$error_msg = __(
+							'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_PARTIAL:
+						$error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_FILE:
+						$error_msg = __('No file was uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_TMP_DIR:
+						$error_msg = __('Missing a temporary folder.', "event_espresso");
+						break;
+					case UPLOAD_ERR_CANT_WRITE:
+						$error_msg = __('Failed to write file to disk.', "event_espresso");
+						break;
+					case UPLOAD_ERR_EXTENSION:
+						$error_msg = __('File upload stopped by extension.', "event_espresso");
+						break;
+					default:
+						$error_msg = __(
+							'An unknown error occurred and the file could not be uploaded',
+							"event_espresso"
+						);
+						break;
+				}
+
+				if (! $error_msg) {
+					$filename = $_FILES['file']['name'][0];
+					$file_ext = substr(strrchr($filename, '.'), 1);
+					$file_type = $_FILES['file']['type'][0];
+					$temp_file = $_FILES['file']['tmp_name'][0];
+					$filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+
+					if ($file_ext == 'csv') {
+						$max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+						if ($filesize < $max_upload || true) {
+							$wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
+							$path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+
+							if (move_uploaded_file($temp_file, $path_to_file)) {
+								// convert csv to array
+								$this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
+
+								// was data successfully stored in an array?
+								if (is_array($this->csv_array)) {
+									$import_what = str_replace('csv_import_', '', $_REQUEST['action']);
+									$import_what = str_replace('_', ' ', ucwords($import_what));
+									$processed_data = $this->csv_array;
+									$this->columns_to_save = false;
+
+									// if any imports require funcky processing, we'll catch them in the switch
+									switch ($_REQUEST['action']) {
+										case "import_events":
+										case "event_list":
+											$import_what = 'Event Details';
+											break;
+
+										case 'groupon_import_csv':
+											$import_what = 'Groupon Codes';
+											$processed_data = $this->process_groupon_codes();
+											break;
+									}
+									// save processed codes to db
+									if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
+										return true;
+									}
+								} else {
+									// no array? must be an error
+									EE_Error::add_error(
+										sprintf(__("No file seems to have been uploaded", "event_espresso")),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									return false;
+								}
+							} else {
+								EE_Error::add_error(
+									sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+						} else {
+							EE_Error::add_error(
+								sprintf(
+									__(
+										"%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
+										"event_espresso"
+									),
+									$filename,
+									$max_upload
+								),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+							return false;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				}
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
+	 *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
+	 *    next level being numeric indexes adn each value representing a model object, and the last layer down
+	 *    being keys of model fields and their proposed values.
+	 *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
+	 *    If the CSV data says (in the metadata row) that it's from the SAME database,
+	 *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
+	 *    IDs DON'T exist in the database, they're treated as temporary IDs,
+	 *    which can used elsewhere to refer to the same object. Once an item
+	 *    with a temporary ID gets inserted, we record its mapping from temporary
+	 *    ID to real ID, and use the real ID in place of the temporary ID
+	 *    when that temporary ID was used as a foreign key.
+	 *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
+	 *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
+	 *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
+	 *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
+	 *    An important exception are non-auto-increment primary keys. If one entry in the
+	 *    CSV file has the same ID as one in the DB, we assume they are meant to be
+	 *    the same item, and instead update the item in the DB with that same ID.
+	 *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
+	 *    time you import a CSV from a different site, we remember their mappings, and
+	 * will try to update the item in the DB instead of inserting another item (eg
+	 * if we previously imported an event with temporary ID 1, and then it got a
+	 * real ID of 123, we remember that. So the next time we import an event with
+	 * temporary ID, from the same site, we know that it's real ID is 123, and will
+	 * update that event, instead of adding a new event).
+	 *
+	 * @access public
+	 * @param array $csv_data_array - the array containing the csv data produced from
+	 *                              EE_CSV::import_csv_to_model_data_array()
+	 * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
+	 *                              fields they will be saved to
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
+	{
+		$success = false;
+		$error = false;
+		// whther to treat this import as if it's data froma different database or not
+		// ie, if it IS from a different database, ignore foreign keys whihf
+		$export_from_site_a_to_b = true;
+		// first level of array is not table information but a table name was passed to the function
+		// array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
+		if ($model_name) {
+			$csv_data_array = array($csv_data_array);
+		}
+		// begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
+		$old_site_url = 'none-specified';
+		// hanlde metadata
+		if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
+			$csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+			// ok so its metadata, dont try to save it to ehte db obviously...
+			if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from the same database, so attempting to update data",
+							"event_espresso"
+						)
+					)
+				);
+				$export_from_site_a_to_b = false;
+			} else {
+				$old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
+							"event_espresso"
+						),
+						$old_site_url,
+						site_url()
+					)
+				);
+			};
+			unset($csv_data_array[ EE_CSV::metadata_header ]);
+		}
+		/**
+		 * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
+		 * the value will be the newly-inserted ID.
+		 * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
+		 */
+		$old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+		if ($old_db_to_new_db_mapping) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						"We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
+						"event_espresso"
+					),
+					$old_site_url,
+					site_url()
+				)
+			);
+		}
+		$old_db_to_new_db_mapping = $this->save_data_rows_to_db(
+			$csv_data_array,
+			$export_from_site_a_to_b,
+			$old_db_to_new_db_mapping
+		);
+
+		// save the mapping from old db to new db in case they try re-importing the same data from the same website again
+		update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+
+		if ($this->_total_updates > 0) {
+			EE_Error::add_success(
+				sprintf(
+					__("%s existing records in the database were updated.", "event_espresso"),
+					$this->_total_updates
+				)
+			);
+			$success = true;
+		}
+		if ($this->_total_inserts > 0) {
+			EE_Error::add_success(
+				sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
+			);
+			$success = true;
+		}
+
+		if ($this->_total_update_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
+						"event_espresso"
+					),
+					$this->_total_update_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+		if ($this->_total_insert_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
+						"event_espresso"
+					),
+					$this->_total_insert_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+
+		// lastly, we need to update the datetime and ticket sold amounts
+		// as those may have been affected by this
+		EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
+
+		// if there was at least one success and absolutely no errors
+		if ($success && ! $error) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Processes the array of data, given the knowledge that it's from the same database or a different one,
+	 * and the mapping from temporary IDs to real IDs.
+	 * If the data is from a different database, we treat the primary keys and their corresponding
+	 * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
+	 * in the real target database. As items are inserted, their temporary primary keys
+	 * are mapped to the real IDs in the target database. Also, before doing any update or
+	 * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
+	 * An exception: string primary keys are treated as real IDs, or else we'd need to
+	 * dynamically generate new string primary keys which would be very awkard for the country table etc.
+	 * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
+	 * combination of fields) to create a unique string identifying the row and store
+	 * those in the mapping.
+	 *
+	 * If the data is from the same database, we usually treat primary keys as real IDs.
+	 * An exception is if there is nothing in the database for that ID. If that's the case,
+	 * we need to insert a new row for that ID, and then map from the non-existent ID
+	 * to the newly-inserted real ID.
+	 *
+	 * @param type $csv_data_array
+	 * @param type $export_from_site_a_to_b
+	 * @param type $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
+	{
+		foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
+			// now check that assumption was correct. If
+			if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
+				$model_name = $model_name_in_csv_data;
+			} else {
+				// no table info in the array and no table name passed to the function?? FAIL
+				EE_Error::add_error(
+					__(
+						'No table information was specified and/or found, therefore the import could not be completed',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/* @var $model EEM_Base */
+			$model = EE_Registry::instance()->load_model($model_name);
+
+			// so without further ado, scanning all the data provided for primary keys and their inital values
+			foreach ($model_data_from_import as $model_object_data) {
+				// before we do ANYTHING, make sure the csv row wasn't just completely blank
+				$row_is_completely_empty = true;
+				foreach ($model_object_data as $field) {
+					if ($field) {
+						$row_is_completely_empty = false;
+					}
+				}
+				if ($row_is_completely_empty) {
+					continue;
+				}
+				// find the PK in the row of data (or a combined key if
+				// there is no primary key)
+				if ($model->has_primary_key_field()) {
+					$id_in_csv = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					$id_in_csv = $model->get_index_primary_key_string($model_object_data);
+				}
+
+
+				$model_object_data = $this->_replace_temp_ids_with_mappings(
+					$model_object_data,
+					$model,
+					$old_db_to_new_db_mapping,
+					$export_from_site_a_to_b
+				);
+				// now we need to decide if we're going to add a new model object given the $model_object_data,
+				// or just update.
+				if ($export_from_site_a_to_b) {
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {// this is just a re-import
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				}
+				if ($what_to_do == self::do_nothing) {
+					continue;
+				}
+
+				// double-check we actually want to insert, if that's what we're planning
+				// based on whether this item would be unique in the DB or not
+				if ($what_to_do == self::do_insert) {
+					// we're supposed to be inserting. But wait, will this thing
+					// be acceptable if inserted?
+					$conflicting = $model->get_one_conflicting($model_object_data, false);
+					if ($conflicting) {
+						// ok, this item would conflict if inserted. Just update the item that it conflicts with.
+						$what_to_do = self::do_update;
+						// and if this model has a primary key, remember its mapping
+						if ($model->has_primary_key_field()) {
+							$old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
+							$model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+						} else {
+							// we want to update this conflicting item, instead of inserting a conflicting item
+							// so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
+							// for the WHERE conditions in the update). At the time of this comment, there were no models like this
+							foreach ($model->get_combined_primary_key_fields() as $key_field) {
+								$model_object_data[ $key_field->get_name() ] = $conflicting->get(
+									$key_field->get_name()
+								);
+							}
+						}
+					}
+				}
+				if ($what_to_do == self::do_insert) {
+					$old_db_to_new_db_mapping = $this->_insert_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} elseif ($what_to_do == self::do_update) {
+					$old_db_to_new_db_mapping = $this->_update_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
+								'event_espresso'
+							),
+							$what_to_do
+						)
+					);
+				}
+			}
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Decides whether or not to insert, given that this data is from another database.
+	 * So, if the primary key of this $model_object_data already exists in the database,
+	 * it's just a coincidence and we should still insert. The only time we should
+	 * update is when we know what it maps to, or there's something that would
+	 * conflict (and we should instead just update that conflicting thing)
+	 *
+	 * @param string   $id_in_csv
+	 * @param array    $model_object_data        by reference so it can be modified
+	 * @param EEM_Base $model
+	 * @param array    $old_db_to_new_db_mapping by reference so it can be modified
+	 * @return string one of the consts on this class that starts with do_*
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
+		$id_in_csv,
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping
+	) {
+		$model_name = $model->get_this_model_name();
+		// if it's a site-to-site export-and-import, see if this modelobject's id
+		// in the old data that we know of
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * If this thing basically already exists in the database, we want to update it;
+	 * otherwise insert it (ie, someone tweaked the CSV file, or the item was
+	 * deleted in the database so it should be re-inserted)
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
+		$id_in_csv,
+		$model_object_data,
+		$model
+	) {
+		// in this case, check if this thing ACTUALLY exists in the database
+		if ($model->get_one_conflicting($model_object_data)) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
+	 * with their mapped real IDs. Eg, if importing from site A to B, the mapping
+	 * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
+	 * So this function searches for any event temp Ids called "my_event_id" and
+	 * replaces them with 123.
+	 * Also, if there is no temp ID for the INT foreign keys from another database,
+	 * replaces them with 0 or the field's default.
+	 *
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @param boolean  $export_from_site_a_to_b
+	 * @return array updated model object data with temp IDs removed
+	 */
+	protected function _replace_temp_ids_with_mappings(
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping,
+		$export_from_site_a_to_b
+	) {
+		// if this model object's primary key is in the mapping, replace it
+		if (
+			$model->has_primary_key_field() &&
+			$model->get_primary_key_field()->is_auto_increment() &&
+			isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+			isset(
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+			)
+		) {
+			$model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
+			) ][ $model_object_data[ $model->primary_key_name() ] ];
+		}
+
+		try {
+			$model_name_field = $model->get_field_containing_related_model_name();
+			$models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
+		} catch (EE_Error $e) {
+			$model_name_field = null;
+			$models_pointed_to_by_model_name_field = array();
+		}
+		foreach ($model->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
+				$models_pointed_to = $field_obj->get_model_names_pointed_to();
+				$found_a_mapping = false;
+				foreach ($models_pointed_to as $model_pointed_to_by_fk) {
+					if ($model_name_field) {
+						$value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+						if ($value_of_model_name_field == $model_pointed_to_by_fk) {
+							$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+								$model_object_data[ $field_obj->get_name() ],
+								$model_pointed_to_by_fk,
+								$old_db_to_new_db_mapping,
+								$export_from_site_a_to_b
+							);
+							$found_a_mapping = true;
+							break;
+						}
+					} else {
+						$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+							$model_object_data[ $field_obj->get_name() ],
+							$model_pointed_to_by_fk,
+							$old_db_to_new_db_mapping,
+							$export_from_site_a_to_b
+						);
+						$found_a_mapping = true;
+					}
+					// once we've found a mapping for this field no need to continue
+					if ($found_a_mapping) {
+						break;
+					}
+				}
+			} else {
+				// it's a string foreign key (which we leave alone, because those are things
+				// like country names, which we'd really rather not make 2 USAs etc (we'd actually
+				// prefer to just update one)
+				// or it's just a regular value that ought to be replaced
+			}
+		}
+		//
+		if ($model instanceof EEM_Term_Taxonomy) {
+			$model_object_data = $this->_handle_split_term_ids($model_object_data);
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
+	 * this term-taxonomy refers to may be out-of-date so we need to update it.
+	 * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
+	 *
+	 * @param type $model_object_data
+	 * @return array new model object data
+	 */
+	protected function _handle_split_term_ids($model_object_data)
+	{
+		if (
+			isset($model_object_data['term_id'])
+			&& isset($model_object_data['taxonomy'])
+			&& apply_filters(
+				'FHEE__EE_Import__handle_split_term_ids__function_exists',
+				function_exists('wp_get_split_term'),
+				$model_object_data
+			)
+		) {
+			$new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
+			if ($new_term_id) {
+				$model_object_data['term_id'] = $new_term_id;
+			}
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * Given the object's ID and its model's name, find it int he mapping data,
+	 * bearing in mind where it came from
+	 *
+	 * @param type   $object_id
+	 * @param string $model_name
+	 * @param array  $old_db_to_new_db_mapping
+	 * @param type   $export_from_site_a_to_b
+	 * @return int
+	 */
+	protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
+	{
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
+			return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+		} elseif ($object_id == '0' || $object_id == '') {
+			// leave as-is
+			return $object_id;
+		} elseif ($export_from_site_a_to_b) {
+			// we couldn't find a mapping for this, and it's from a different site,
+			// so blank it out
+			return null;
+		} elseif (! $export_from_site_a_to_b) {
+			// we coudln't find a mapping for this, but it's from thsi DB anyway
+			// so let's just leave it as-is
+			return $object_id;
+		}
+	}
+
+	/**
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		// remove the primary key, if there is one (we don't want it for inserts OR updates)
+		// we'll put it back in if we need it
+		if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
+			$effective_id = $model_object_data[ $model->primary_key_name() ];
+			unset($model_object_data[ $model->primary_key_name() ]);
+		} else {
+			$effective_id = $model->get_index_primary_key_string($model_object_data);
+		}
+		// the model takes care of validating the CSV's input
+		try {
+			$new_id = $model->insert($model_object_data);
+			if ($new_id) {
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+				$this->_total_inserts++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						$new_id,
+						implode(",", $model_object_data)
+					)
+				);
+			} else {
+				$this->_total_insert_errors++;
+				// put the ID used back in there for the error message
+				if ($model->has_primary_key_field()) {
+					$model_object_data[ $model->primary_key_name() ] = $effective_id;
+				}
+				EE_Error::add_error(
+					sprintf(
+						__("Could not insert new %s with the csv data: %s", "event_espresso"),
+						$model->get_this_model_name(),
+						http_build_query($model_object_data)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} catch (EE_Error $e) {
+			$this->_total_insert_errors++;
+			if ($model->has_primary_key_field()) {
+				$model_object_data[ $model->primary_key_name() ] = $effective_id;
+			}
+			EE_Error::add_error(
+				sprintf(
+					__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
+					$model->get_this_model_name(),
+					implode(",", $model_object_data),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Given the model object data, finds the row to update and updates it
+	 *
+	 * @param string|int $id_in_csv
+	 * @param array      $model_object_data
+	 * @param EEM_Base   $model
+	 * @param array      $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		try {
+			// let's keep two copies of the model object data:
+			// one for performing an update, one for everthing else
+			$model_object_data_for_update = $model_object_data;
+			if ($model->has_primary_key_field()) {
+				$conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+				// remove the primary key because we shouldn't use it for updating
+				unset($model_object_data_for_update[ $model->primary_key_name() ]);
+			} elseif ($model->get_combined_primary_key_fields() > 1) {
+				$conditions = array();
+				foreach ($model->get_combined_primary_key_fields() as $key_field) {
+					$conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+				}
+			} else {
+				$model->primary_key_name(
+				);// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+			}
+
+			$success = $model->update($model_object_data_for_update, array($conditions));
+			if ($success) {
+				$this->_total_updates++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully updated %s with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						implode(",", $model_object_data_for_update)
+					)
+				);
+				// we should still record the mapping even though it was an update
+				// because if we were going to insert somethign but it was going to conflict
+				// we would have last-minute decided to update. So we'd like to know what we updated
+				// and so we record what record ended up being updated using the mapping
+				if ($model->has_primary_key_field()) {
+					$new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					// no primary key just a combined key
+					$new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
+				}
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+			} else {
+				$matched_items = $model->get_all(array($conditions));
+				if (! $matched_items) {
+					// no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
+					$this->_total_update_errors++;
+					EE_Error::add_error(
+						sprintf(
+							__(
+								"Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							http_build_query($model_object_data),
+							http_build_query($conditions)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				} else {
+					$this->_total_updates++;
+					EE_Error::add_success(
+						sprintf(
+							__(
+								"%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							implode(",", $model_object_data)
+						)
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$this->_total_update_errors++;
+			$basic_message = sprintf(
+				__("Could not update %s with the csv data: %s because %s", "event_espresso"),
+				$model->get_this_model_name(),
+				implode(",", $model_object_data),
+				$e->getMessage()
+			);
+			$debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+			EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Gets the number of inserts performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_inserts()
+	{
+		return $this->_total_inserts;
+	}
+
+	/**
+	 *  Gets the number of insert errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_insert_errors()
+	{
+		return $this->_total_insert_errors;
+	}
+
+	/**
+	 *  Gets the number of updates performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_updates()
+	{
+		return $this->_total_updates;
+	}
+
+	/**
+	 *  Gets the number of update errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_update_errors()
+	{
+		return $this->_total_update_errors;
+	}
 }