eventespresso / event-espresso-core

core/db_classes/EE_Event.class.php

Indentation +1633 added lines, -1633 removed lines

@@ -16,1640 +16,1640 @@
  */
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = []): EE_Event
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ?: new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null): EE_Event
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAvailableSpacesCalculator(): EventSpacesCalculator
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @param string $status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_status($status = '', $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $status) {
-            // TO sold_out
-            if ($status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array|null $query_params
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function datetimes(?array $query_params = []): array
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event that are currently ACTIVE,
-     * meaning the datetime has started and has not yet ended.
-     *
-     * @param int|null   $start_date   timestamp to use for event date start time, defaults to NOW unless set to 0
-     * @param array|null $query_params will recursively replace default values
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function activeDatetimes(?int $start_date, ?array $query_params = []): array
-    {
-        // if start date is null, then use current time
-        $start_date = $start_date ?? time();
-        $where      = [];
-        if ($start_date) {
-            $where['DTT_EVT_start'] = ['<', $start_date];
-            $where['DTT_EVT_end']   = ['>', time()];
-        }
-        $query_params = array_replace_recursive(
-            [
-                $where,
-                'order_by' => ['DTT_EVT_start' => 'ASC'],
-            ],
-            $query_params
-        );
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_in_chronological_order(): array
-    {
-        return $this->get_many_related('Datetime', ['order_by' => ['DTT_EVT_start' => 'ASC']]);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param bool     $show_expired whether or not to include expired events
-     * @param bool     $show_deleted whether or not to include deleted events
-     * @param int|null $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_ordered(bool $show_expired = true, bool $show_deleted = false, ?int $limit = null): array
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_datetime(): EE_Datetime
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function primary_datetime(
-        bool $try_to_exclude_expired = true,
-        bool $try_to_exclude_deleted = true
-    ): ?EE_Datetime {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array|null $query_params
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function tickets(?array $query_params = []): array
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return [];
-        }
-        $datetime_ids = [];
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = ['Datetime.DTT_ID' => ['IN', $datetime_ids]];
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired not-trashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function active_tickets(): array
-    {
-        return $this->tickets(
-            [
-                [
-                    'TKT_end_date' => ['>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')],
-                    'TKT_deleted'  => false,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function additional_limit(): int
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function allow_overflow(): bool
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function created(): string
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description(): string
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description_filtered(): string
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_description(): bool
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_ticket_selector(): bool
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function external_url(): ?string
-    {
-        return $this->get('EVT_external_URL') ?? '';
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function member_only(): bool
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function phone(): string
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modified(): string
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name(): string
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function default_registration_status(): string
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int|null    $num_words
-     * @param string|null $more
-     * @param bool        $not_full_desc
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function short_description(?int $num_words = 55, string $more = null, bool $not_full_desc = false): string
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug(): string
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function timezone_string(): string
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public function visible_on(): string
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This method has been deprecated and there is no replacement for it.',
-                'event_espresso'
-            ),
-            '5.0.0.rc.002'
-        );
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function donations(): bool
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param int $limit
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_additional_limit(int $limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public function set_visible_on($visible_on)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This method has been deprecated and there is no replacement for it.',
-                'event_espresso'
-            ),
-            '5.0.0.rc.002'
-        );
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param int|EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj): EE_Venue
-    {
-        $venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function venue_ID(array $query_params = []): int
-    {
-        $venue = $this->get_first_related('Venue', $query_params);
-        return $venue instanceof EE_Venue ? $venue->ID() : 0;
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Venue|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function venue(array $query_params = []): ?EE_Venue
-    {
-        return $this->get_first_related('Venue', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated $VID:$
-     */
-    public function venues(array $query_params = []): array
-    {
-        return [$this->venue($query_params)];
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _has_ID_and_is_published(): bool
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_upcoming(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_active(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_expired(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_inactive(): bool
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array|null $tickets
-     * @param bool       $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public function spaces_remaining(?array $tickets = [], ?bool $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this event's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public function perform_sold_out_status_check(): bool
-    {
-        // get all tickets
-        $tickets     = $this->tickets(
-            [
-                'default_where_conditions' => 'none',
-                'order_by'                 => ['TKT_qty' => 'ASC'],
-            ]
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_CPT_Base::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     * @uses EE_Event::total_available_spaces()
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the quantities on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param bool $consider_sold   Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public function total_available_spaces(bool $consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param bool $actual  whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_sold_out(bool $actual = false): bool
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed(): bool
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled(): bool
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_status(bool $reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = [['EVT_ID' => $this->ID()]];
-        // if event is published:
-        if (
-            $this->status() === EEM_CPT_Base::post_status_publish
-            || $this->status() === EEM_CPT_Base::post_status_private
-        ) {
-            // active?
-            if (
-                EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::active,
-                    $where_params_for_event
-                ) > 0
-            ) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (
-                    EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::upcoming,
-                        $where_params_for_event
-                    ) > 0
-                ) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (
-                        EEM_Datetime::instance()->get_datetime_count_for_status(
-                            EE_Datetime::expired,
-                            $where_params_for_event
-                        ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far
-                        // because it basically means there are no datetimes attached to the event.
-                        // So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pretty_active_status(bool $echo = true): string
-    {
-        $active_status = $this->get_active_status();
-        $status        = "
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = []): EE_Event
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ?: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null): EE_Event
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAvailableSpacesCalculator(): EventSpacesCalculator
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @param string $status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_status($status = '', $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $status) {
+			// TO sold_out
+			if ($status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array|null $query_params
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function datetimes(?array $query_params = []): array
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event that are currently ACTIVE,
+	 * meaning the datetime has started and has not yet ended.
+	 *
+	 * @param int|null   $start_date   timestamp to use for event date start time, defaults to NOW unless set to 0
+	 * @param array|null $query_params will recursively replace default values
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function activeDatetimes(?int $start_date, ?array $query_params = []): array
+	{
+		// if start date is null, then use current time
+		$start_date = $start_date ?? time();
+		$where      = [];
+		if ($start_date) {
+			$where['DTT_EVT_start'] = ['<', $start_date];
+			$where['DTT_EVT_end']   = ['>', time()];
+		}
+		$query_params = array_replace_recursive(
+			[
+				$where,
+				'order_by' => ['DTT_EVT_start' => 'ASC'],
+			],
+			$query_params
+		);
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_in_chronological_order(): array
+	{
+		return $this->get_many_related('Datetime', ['order_by' => ['DTT_EVT_start' => 'ASC']]);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param bool     $show_expired whether or not to include expired events
+	 * @param bool     $show_deleted whether or not to include deleted events
+	 * @param int|null $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_ordered(bool $show_expired = true, bool $show_deleted = false, ?int $limit = null): array
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_datetime(): EE_Datetime
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function primary_datetime(
+		bool $try_to_exclude_expired = true,
+		bool $try_to_exclude_deleted = true
+	): ?EE_Datetime {
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array|null $query_params
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function tickets(?array $query_params = []): array
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return [];
+		}
+		$datetime_ids = [];
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = ['Datetime.DTT_ID' => ['IN', $datetime_ids]];
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired not-trashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function active_tickets(): array
+	{
+		return $this->tickets(
+			[
+				[
+					'TKT_end_date' => ['>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')],
+					'TKT_deleted'  => false,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function additional_limit(): int
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function allow_overflow(): bool
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function created(): string
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description(): string
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description_filtered(): string
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_description(): bool
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_ticket_selector(): bool
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function external_url(): ?string
+	{
+		return $this->get('EVT_external_URL') ?? '';
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function member_only(): bool
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function phone(): string
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modified(): string
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name(): string
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function default_registration_status(): string
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int|null    $num_words
+	 * @param string|null $more
+	 * @param bool        $not_full_desc
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function short_description(?int $num_words = 55, string $more = null, bool $not_full_desc = false): string
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug(): string
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function timezone_string(): string
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public function visible_on(): string
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This method has been deprecated and there is no replacement for it.',
+				'event_espresso'
+			),
+			'5.0.0.rc.002'
+		);
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function donations(): bool
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param int $limit
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_additional_limit(int $limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public function set_visible_on($visible_on)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This method has been deprecated and there is no replacement for it.',
+				'event_espresso'
+			),
+			'5.0.0.rc.002'
+		);
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param int|EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj): EE_Venue
+	{
+		$venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function venue_ID(array $query_params = []): int
+	{
+		$venue = $this->get_first_related('Venue', $query_params);
+		return $venue instanceof EE_Venue ? $venue->ID() : 0;
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Venue|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function venue(array $query_params = []): ?EE_Venue
+	{
+		return $this->get_first_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated $VID:$
+	 */
+	public function venues(array $query_params = []): array
+	{
+		return [$this->venue($query_params)];
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _has_ID_and_is_published(): bool
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_upcoming(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_active(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_expired(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_inactive(): bool
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array|null $tickets
+	 * @param bool       $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public function spaces_remaining(?array $tickets = [], ?bool $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this event's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public function perform_sold_out_status_check(): bool
+	{
+		// get all tickets
+		$tickets     = $this->tickets(
+			[
+				'default_where_conditions' => 'none',
+				'order_by'                 => ['TKT_qty' => 'ASC'],
+			]
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_CPT_Base::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 * @uses EE_Event::total_available_spaces()
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the quantities on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param bool $consider_sold   Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public function total_available_spaces(bool $consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param bool $actual  whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_sold_out(bool $actual = false): bool
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed(): bool
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled(): bool
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_status(bool $reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = [['EVT_ID' => $this->ID()]];
+		// if event is published:
+		if (
+			$this->status() === EEM_CPT_Base::post_status_publish
+			|| $this->status() === EEM_CPT_Base::post_status_private
+		) {
+			// active?
+			if (
+				EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::active,
+					$where_params_for_event
+				) > 0
+			) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (
+					EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::upcoming,
+						$where_params_for_event
+					) > 0
+				) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (
+						EEM_Datetime::instance()->get_datetime_count_for_status(
+							EE_Datetime::expired,
+							$where_params_for_event
+						) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far
+						// because it basically means there are no datetimes attached to the event.
+						// So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pretty_active_status(bool $echo = true): string
+	{
+		$active_status = $this->get_active_status();
+		$status        = "
         <span class='ee-status ee-status-bg--$active_status event-active-status-$active_status'>
             " . EEH_Template::pretty_status($active_status, false, 'sentence') . "
         </span >";
-        if ($echo) {
-            echo wp_kses($status, AllowedTags::getAllowedTags());
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_count_of_all_registrations(): int
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params             = [$where, 'order_by' => ['TKT_start_date' => 'ASC']];
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params             = [$where, 'order_by' => ['TKT_end_date' => 'DESC']];
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function countTicketsOnSale(): int
-    {
-        $where = [
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => ['<', time()],
-            'TKT_end_date'    => ['>', time()],
-        ];
-        return EEM_Ticket::instance()->count([$where]);
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tickets_on_sale(): bool
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_permalink(): string
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function first_event_category(array $query_params = []): ?EE_Term
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_categories(array $query_params = []): array
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
-    {
-        // If the row already exists, it will be updated. If it doesn't, it will be inserted.
-        // That's in EE_HABTM_Relation::add_relation_to().
-        return $this->_add_relation_to(
-            $question_group_id_or_obj,
-            'Question_Group',
-            [
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true,
-            ]
-        );
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, bool $for_primary = false)
-    {
-        // If the question group is used for the other type (primary or additional)
-        // then just update it. If not, delete it outright.
-        $existing_relation = $this->get_first_related(
-            'Event_Question_Group',
-            [
-                [
-                    'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj),
-                ],
-            ]
-        );
-        $field_to_update   = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
-        if ($existing_relation->get($other_field) === false) {
-            // Delete it. It's now no longer for primary or additional question groups.
-            return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
-        }
-        // Just update it. They'll still use this question group for the other category
-        $existing_relation->save(
-            [
-                $field_to_update => false,
-            ]
-        );
-        return $question_group_id_or_obj;
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function question_groups(array $query_params = []): array
-    {
-        $query_params = ! empty($query_params) ? $query_params : ['order_by' => ['QSG_order' => 'ASC']];
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @return string
-     * @see EEI_Visual_Representation for comments
-     */
-    public function get_icon(): string
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_details_link(): string
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_edit_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_settings_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_overview_link(): string
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @return string|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registrationFormUuid(): ?string
-    {
-        return $this->get('FSC_UUID') ?? '';
-    }
-
-
-    /**
-     * Gets all the form sections for this event
-     *
-     * @return EE_Base_Class[]|EE_Form_Section[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registrationForm(): array
-    {
-        $FSC_UUID = $this->registrationFormUuid();
-
-        if (empty($FSC_UUID)) {
-            return [];
-        }
-
-        return EEM_Form_Section::instance()->get_all(
-            [
-                [
-                    'OR' => [
-                        'FSC_UUID'      => $FSC_UUID, // top level form
-                        'FSC_belongsTo' => $FSC_UUID, // child form sections
-                    ],
-                ],
-                'order_by' => ['FSC_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setRegistrationFormUuid(string $UUID): void
-    {
-        if (! Cuid::isCuid($UUID)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                /* translators: 1: UUID value, 2: UUID generator function. */
-                    esc_html__(
-                        'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
-                        'event_espresso'
-                    ),
-                    $UUID,
-                    '`Cuid::cuid()`'
-                )
-            );
-        }
-        $this->set('FSC_UUID', $UUID);
-    }
-
-
-    /**
-     * Get visibility status of event
-     *
-     * @param bool $hide_public
-     * @return string
-     */
-    public function get_visibility_status(bool $hide_public = true): string
-    {
-        if ($this->status() === 'private') {
-            return esc_html__('Private', 'event_espresso');
-        }
-        if (! empty($this->wp_post()->post_password)) {
-            return esc_html__('Password Protected', 'event_espresso');
-        }
-        if (! $hide_public) {
-            return esc_html__('Public', 'event_espresso');
-        }
-
-        return '';
-    }
+		if ($echo) {
+			echo wp_kses($status, AllowedTags::getAllowedTags());
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_count_of_all_registrations(): int
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params             = [$where, 'order_by' => ['TKT_start_date' => 'ASC']];
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params             = [$where, 'order_by' => ['TKT_end_date' => 'DESC']];
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function countTicketsOnSale(): int
+	{
+		$where = [
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => ['<', time()],
+			'TKT_end_date'    => ['>', time()],
+		];
+		return EEM_Ticket::instance()->count([$where]);
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tickets_on_sale(): bool
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_permalink(): string
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function first_event_category(array $query_params = []): ?EE_Term
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_categories(array $query_params = []): array
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy']     = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_question_group($question_group_id_or_obj, bool $for_primary = false): EE_Question_Group
+	{
+		// If the row already exists, it will be updated. If it doesn't, it will be inserted.
+		// That's in EE_HABTM_Relation::add_relation_to().
+		return $this->_add_relation_to(
+			$question_group_id_or_obj,
+			'Question_Group',
+			[
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true,
+			]
+		);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, bool $for_primary = false)
+	{
+		// If the question group is used for the other type (primary or additional)
+		// then just update it. If not, delete it outright.
+		$existing_relation = $this->get_first_related(
+			'Event_Question_Group',
+			[
+				[
+					'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj),
+				],
+			]
+		);
+		$field_to_update   = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
+		$other_field       = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+		if ($existing_relation->get($other_field) === false) {
+			// Delete it. It's now no longer for primary or additional question groups.
+			return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
+		}
+		// Just update it. They'll still use this question group for the other category
+		$existing_relation->save(
+			[
+				$field_to_update => false,
+			]
+		);
+		return $question_group_id_or_obj;
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function question_groups(array $query_params = []): array
+	{
+		$query_params = ! empty($query_params) ? $query_params : ['order_by' => ['QSG_order' => 'ASC']];
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @return string
+	 * @see EEI_Visual_Representation for comments
+	 */
+	public function get_icon(): string
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_details_link(): string
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_edit_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_settings_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_overview_link(): string
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @return string|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registrationFormUuid(): ?string
+	{
+		return $this->get('FSC_UUID') ?? '';
+	}
+
+
+	/**
+	 * Gets all the form sections for this event
+	 *
+	 * @return EE_Base_Class[]|EE_Form_Section[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registrationForm(): array
+	{
+		$FSC_UUID = $this->registrationFormUuid();
+
+		if (empty($FSC_UUID)) {
+			return [];
+		}
+
+		return EEM_Form_Section::instance()->get_all(
+			[
+				[
+					'OR' => [
+						'FSC_UUID'      => $FSC_UUID, // top level form
+						'FSC_belongsTo' => $FSC_UUID, // child form sections
+					],
+				],
+				'order_by' => ['FSC_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setRegistrationFormUuid(string $UUID): void
+	{
+		if (! Cuid::isCuid($UUID)) {
+			throw new InvalidArgumentException(
+				sprintf(
+				/* translators: 1: UUID value, 2: UUID generator function. */
+					esc_html__(
+						'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
+						'event_espresso'
+					),
+					$UUID,
+					'`Cuid::cuid()`'
+				)
+			);
+		}
+		$this->set('FSC_UUID', $UUID);
+	}
+
+
+	/**
+	 * Get visibility status of event
+	 *
+	 * @param bool $hide_public
+	 * @return string
+	 */
+	public function get_visibility_status(bool $hide_public = true): string
+	{
+		if ($this->status() === 'private') {
+			return esc_html__('Private', 'event_espresso');
+		}
+		if (! empty($this->wp_post()->post_password)) {
+			return esc_html__('Password Protected', 'event_espresso');
+		}
+		if (! $hide_public) {
+			return esc_html__('Public', 'event_espresso');
+		}
+
+		return '';
+	}
 }

core/services/database/WordPressOption.php

Indentation +177 added lines, -177 removed lines

@@ -17,181 +17,181 @@
  */
 abstract class WordPressOption
 {
-    public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
-
-    /**
-     * WordPress makes it difficult to determine if an option successfully saved or not,
-     * which is sometimes really important to know, especially if the information you are saving is critical.
-     * The following options allow us to have a better chance of knowing when an update actually failed
-     * or when everything is OK but it just didn't update because the value hasn't changed.
-     */
-    public const UPDATE_SUCCESS = 1;
-
-    public const UPDATE_NONE = 0;
-
-    public const UPDATE_ERROR = -1;
-
-    /**
-     * @var bool
-     */
-    private $autoload = false;
-
-    /**
-     * @var mixed
-     */
-    private $default_value = null;
-
-    /**
-     * @var string
-     */
-    private $option_name = '';
-
-    /**
-     * @var mixed
-     */
-    private $value = WordPressOption::NOT_SET_YET;
-
-    /**
-     * @var OptionEngine
-     */
-    private $option_engine;
-
-
-    /**
-     * WordPressOption constructor.
-     *
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @param bool   $autoload              if true, will load the option on EVERY request
-     * @param bool   $is_network_option     if true, will save the option to the network as opposed to the current blog
-     */
-    public function __construct(
-        string $option_name,
-        $default_value,
-        bool $autoload = false,
-        bool $is_network_option = false
-    ) {
-        $this->setAutoload($autoload);
-        $this->setDefaultValue($default_value);
-        $this->setOptionName($option_name);
-        $this->option_engine = new OptionEngine($is_network_option);
-    }
-
-
-    /**
-     * @param bool|string $autoload
-     */
-    public function setAutoload($autoload): void
-    {
-        $this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param mixed $default_value
-     */
-    public function setDefaultValue($default_value): void
-    {
-        $this->default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $option_name
-     */
-    public function setOptionName(string $option_name): void
-    {
-        $this->option_name = sanitize_key($option_name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function optionExists(): string
-    {
-        return $this->option_engine->getOption(
-            $this->getOptionName(),
-            WordPressOption::NOT_SET_YET
-        ) !== WordPressOption::NOT_SET_YET;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOptionName(): string
-    {
-        return $this->option_name;
-    }
-
-
-    /**
-     * @return false|mixed|void
-     */
-    public function loadOption()
-    {
-        if ($this->value === WordPressOption::NOT_SET_YET) {
-            $this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
-        }
-        return $this->value;
-    }
-
-
-    /**
-     * @param $value
-     * @return int
-     */
-    public function updateOption($value): int
-    {
-        // don't update if value has not changed since last update
-        if ($this->valueIsUnchanged($value)) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        $this->value = $value;
-        // because the options for updating differ when adding an option for the first time
-        // we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
-        $updated = $this->optionExists()
-            ? $this->option_engine->updateOption($this->getOptionName(), $this->value)
-            : $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
-
-        if ($updated) {
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    private function valueIsUnchanged($value): bool
-    {
-        if (is_array($value) && is_array($this->value)) {
-            $diff = EEH_Array::array_diff_recursive($value, $this->value);
-            // $diff = array_diff($value, $this->value);
-            return empty($diff);
-        }
-        // emulate WP's method for checking equality
-        return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
-    }
-
-
-    /**
-     * @return string
-     */
-    private function autoload(): string
-    {
-        return $this->autoload ? 'yes' : 'no';
-    }
-
-
-    /**
-     * Deletes the option from the database
-     * for the rest of the request
-     *
-     * @return bool
-     * @since  $VID:$
-     */
-    public function deleteOption(): bool
-    {
-        return $this->option_engine->deleteOption($this->getOptionName());
-    }
+	public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
+
+	/**
+	 * WordPress makes it difficult to determine if an option successfully saved or not,
+	 * which is sometimes really important to know, especially if the information you are saving is critical.
+	 * The following options allow us to have a better chance of knowing when an update actually failed
+	 * or when everything is OK but it just didn't update because the value hasn't changed.
+	 */
+	public const UPDATE_SUCCESS = 1;
+
+	public const UPDATE_NONE = 0;
+
+	public const UPDATE_ERROR = -1;
+
+	/**
+	 * @var bool
+	 */
+	private $autoload = false;
+
+	/**
+	 * @var mixed
+	 */
+	private $default_value = null;
+
+	/**
+	 * @var string
+	 */
+	private $option_name = '';
+
+	/**
+	 * @var mixed
+	 */
+	private $value = WordPressOption::NOT_SET_YET;
+
+	/**
+	 * @var OptionEngine
+	 */
+	private $option_engine;
+
+
+	/**
+	 * WordPressOption constructor.
+	 *
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @param bool   $autoload              if true, will load the option on EVERY request
+	 * @param bool   $is_network_option     if true, will save the option to the network as opposed to the current blog
+	 */
+	public function __construct(
+		string $option_name,
+		$default_value,
+		bool $autoload = false,
+		bool $is_network_option = false
+	) {
+		$this->setAutoload($autoload);
+		$this->setDefaultValue($default_value);
+		$this->setOptionName($option_name);
+		$this->option_engine = new OptionEngine($is_network_option);
+	}
+
+
+	/**
+	 * @param bool|string $autoload
+	 */
+	public function setAutoload($autoload): void
+	{
+		$this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param mixed $default_value
+	 */
+	public function setDefaultValue($default_value): void
+	{
+		$this->default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $option_name
+	 */
+	public function setOptionName(string $option_name): void
+	{
+		$this->option_name = sanitize_key($option_name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function optionExists(): string
+	{
+		return $this->option_engine->getOption(
+			$this->getOptionName(),
+			WordPressOption::NOT_SET_YET
+		) !== WordPressOption::NOT_SET_YET;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOptionName(): string
+	{
+		return $this->option_name;
+	}
+
+
+	/**
+	 * @return false|mixed|void
+	 */
+	public function loadOption()
+	{
+		if ($this->value === WordPressOption::NOT_SET_YET) {
+			$this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
+		}
+		return $this->value;
+	}
+
+
+	/**
+	 * @param $value
+	 * @return int
+	 */
+	public function updateOption($value): int
+	{
+		// don't update if value has not changed since last update
+		if ($this->valueIsUnchanged($value)) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		$this->value = $value;
+		// because the options for updating differ when adding an option for the first time
+		// we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
+		$updated = $this->optionExists()
+			? $this->option_engine->updateOption($this->getOptionName(), $this->value)
+			: $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
+
+		if ($updated) {
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	private function valueIsUnchanged($value): bool
+	{
+		if (is_array($value) && is_array($this->value)) {
+			$diff = EEH_Array::array_diff_recursive($value, $this->value);
+			// $diff = array_diff($value, $this->value);
+			return empty($diff);
+		}
+		// emulate WP's method for checking equality
+		return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function autoload(): string
+	{
+		return $this->autoload ? 'yes' : 'no';
+	}
+
+
+	/**
+	 * Deletes the option from the database
+	 * for the rest of the request
+	 *
+	 * @return bool
+	 * @since  $VID:$
+	 */
+	public function deleteOption(): bool
+	{
+		return $this->option_engine->deleteOption($this->getOptionName());
+	}
 }

core/services/request/Response.php

Indentation +135 added lines, -135 removed lines

@@ -14,139 +14,139 @@
  */
 class Response implements ResponseInterface, ReservedInstanceInterface
 {
-    protected bool  $deactivate_plugin = false;
-
-    protected array $notice            = [];
-
-    /**
-     * rendered output to be returned to WP
-     */
-    protected array $output             = [];
-
-    protected array $request_headers    = [];
-
-    protected bool  $request_terminated = false;
-
-
-    /**
-     * EE_Response constructor.
-     */
-    public function __construct()
-    {
-        $this->terminateRequest(false);
-    }
-
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value)
-    {
-        $this->notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key)
-    {
-        return $this->notice[ $key ] ?? null;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getNotices(): array
-    {
-        return $this->notice;
-    }
-
-
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput(string $string, bool $append = true)
-    {
-        if ($append) {
-            $this->output[] = $string;
-            return;
-        }
-        array_unshift($this->output, $string);
-    }
-
-
-    /**
-     * @param bool   $as_string
-     * @param string $separator
-     * @return array|string
-     */
-    public function getOutput(bool $as_string = true, string $separator = PHP_EOL)
-    {
-        return $as_string
-            ? implode($separator, $this->output)
-            : $this->output;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function requestTerminated(): bool
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @param bool|int|string|null $request_terminated
-     */
-    public function terminateRequest($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated(): bool
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin()
-    {
-        $this->deactivate_plugin = true;
-    }
-
-
-    /**
-     * @return array
-     * @since $VID:$
-     */
-    public function requestHeaders(): array
-    {
-        return $this->request_headers;
-    }
-
-
-    /**
-     * @param string $request_header
-     * @return void
-     * @since $VID:$
-     */
-    public function setRequestHeader(string $request_header): void
-    {
-        $this->request_headers[] = $request_header;
-    }
+	protected bool  $deactivate_plugin = false;
+
+	protected array $notice            = [];
+
+	/**
+	 * rendered output to be returned to WP
+	 */
+	protected array $output             = [];
+
+	protected array $request_headers    = [];
+
+	protected bool  $request_terminated = false;
+
+
+	/**
+	 * EE_Response constructor.
+	 */
+	public function __construct()
+	{
+		$this->terminateRequest(false);
+	}
+
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value)
+	{
+		$this->notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key)
+	{
+		return $this->notice[ $key ] ?? null;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getNotices(): array
+	{
+		return $this->notice;
+	}
+
+
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput(string $string, bool $append = true)
+	{
+		if ($append) {
+			$this->output[] = $string;
+			return;
+		}
+		array_unshift($this->output, $string);
+	}
+
+
+	/**
+	 * @param bool   $as_string
+	 * @param string $separator
+	 * @return array|string
+	 */
+	public function getOutput(bool $as_string = true, string $separator = PHP_EOL)
+	{
+		return $as_string
+			? implode($separator, $this->output)
+			: $this->output;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated(): bool
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @param bool|int|string|null $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated(): bool
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin()
+	{
+		$this->deactivate_plugin = true;
+	}
+
+
+	/**
+	 * @return array
+	 * @since $VID:$
+	 */
+	public function requestHeaders(): array
+	{
+		return $this->request_headers;
+	}
+
+
+	/**
+	 * @param string $request_header
+	 * @return void
+	 * @since $VID:$
+	 */
+	public function setRequestHeader(string $request_header): void
+	{
+		$this->request_headers[] = $request_header;
+	}
 }

core/services/request/ResponseInterface.php

Indentation +53 added lines, -53 removed lines

@@ -11,77 +11,77 @@
  */
 interface ResponseInterface
 {
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value);
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value);
 
 
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key);
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key);
 
 
-    /**
-     * @return    array
-     */
-    public function getNotices(): array;
+	/**
+	 * @return    array
+	 */
+	public function getNotices(): array;
 
 
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput(string $string, bool $append = true);
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput(string $string, bool $append = true);
 
 
-    /**
-     * @param bool   $as_string
-     * @param string $separator
-     * @return array|string
-     */
-    public function getOutput(bool $as_string = true, string $separator = PHP_EOL);
+	/**
+	 * @param bool   $as_string
+	 * @param string $separator
+	 * @return array|string
+	 */
+	public function getOutput(bool $as_string = true, string $separator = PHP_EOL);
 
 
-    /**
-     * @return boolean
-     */
-    public function requestTerminated(): bool;
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated(): bool;
 
 
-    /**
-     * @param bool|int|string|null $request_terminated
-     */
-    public function terminateRequest($request_terminated = true);
+	/**
+	 * @param bool|int|string|null $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true);
 
 
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated(): bool;
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated(): bool;
 
 
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin();
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin();
 
 
-    /**
-     * @return array
-     * @since $VID:$
-     */
-    public function requestHeaders(): array;
+	/**
+	 * @return array
+	 * @since $VID:$
+	 */
+	public function requestHeaders(): array;
 
 
-    /**
-     * @param string $request_header
-     * @return void
-     * @since $VID:$
-     */
-    public function setRequestHeader(string $request_header): void;
+	/**
+	 * @param string $request_header
+	 * @return void
+	 * @since $VID:$
+	 */
+	public function setRequestHeader(string $request_header): void;
 }

core/services/i18n/LegacyTextDomainOptions.php

Indentation +45 added lines, -45 removed lines

@@ -14,53 +14,53 @@
  */
 class LegacyTextDomainOptions
 {
-    /**
-     * @var LoadedTextDomains
-     */
-    private $loaded_text_domains;
+	/**
+	 * @var LoadedTextDomains
+	 */
+	private $loaded_text_domains;
 
 
-    /**
-     * @param LoadedTextDomains|null $loaded_text_domains
-     */
-    public function __construct(?LoadedTextDomains $loaded_text_domains = null)
-    {
-        $this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
-    }
+	/**
+	 * @param LoadedTextDomains|null $loaded_text_domains
+	 */
+	public function __construct(?LoadedTextDomains $loaded_text_domains = null)
+	{
+		$this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
+	}
 
 
-    /**
-     * attempts to collect all of the ee_lang_check_* options stored in the database
-     * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
-     *
-     * @since   $VID:$
-     */
-    public function convertToConsolidatedFormat()
-    {
-        $options = wp_load_alloptions();
-        foreach ($options as $slug => $values) {
-            if (strpos($slug, 'ee_lang_check_') === 0) {
-                // convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
-                $locale_version = str_replace('ee_lang_check_', '', $slug);
-                // split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
-                $locale_version = explode('_', $locale_version);
-                $locale         = null;
-                $version        = null;
-                switch (count($locale_version)) {
-                    case 3:
-                        $locale  = "$locale_version[0]_$locale_version[1]";
-                        $version = $locale_version[2];
-                        break;
-                    case 2:
-                        $locale  = $locale_version[0];
-                        $version = $locale_version[1];
-                        break;
-                }
-                if ($locale && $version) {
-                    $this->loaded_text_domains->versionLoaded($locale, $version);
-                    delete_option($slug);
-                }
-            }
-        }
-    }
+	/**
+	 * attempts to collect all of the ee_lang_check_* options stored in the database
+	 * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
+	 *
+	 * @since   $VID:$
+	 */
+	public function convertToConsolidatedFormat()
+	{
+		$options = wp_load_alloptions();
+		foreach ($options as $slug => $values) {
+			if (strpos($slug, 'ee_lang_check_') === 0) {
+				// convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
+				$locale_version = str_replace('ee_lang_check_', '', $slug);
+				// split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
+				$locale_version = explode('_', $locale_version);
+				$locale         = null;
+				$version        = null;
+				switch (count($locale_version)) {
+					case 3:
+						$locale  = "$locale_version[0]_$locale_version[1]";
+						$version = $locale_version[2];
+						break;
+					case 2:
+						$locale  = $locale_version[0];
+						$version = $locale_version[1];
+						break;
+				}
+				if ($locale && $version) {
+					$this->loaded_text_domains->versionLoaded($locale, $version);
+					delete_option($slug);
+				}
+			}
+		}
+	}
 }

core/helpers/EEH_Form_Fields.helper.php

Indentation +2065 added lines, -2065 removed lines

@@ -27,1058 +27,1058 @@ 
  */
 class EEH_Form_Fields
 {
-    /**
-     *  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' => esc_html__('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 $form_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 = [], $form_id = false)
-    {
-
-        if (empty($input_vars)) {
-            EE_Error::add_error(
-                esc_html__('missing required variables for the form field generator', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $output        = "";
-        $inputs        = [];
-        $hidden_inputs = [];
-
-        // cycle thru inputs
-        foreach ($input_vars as $input_key => $input_value) {
-            $defaults = [
-                'append_content' => '',
-                'css_class'      => '',
-                'cols'           => 80,
-                'db-col'         => 'column_in_db',
-                'format'         => '%d',
-                'input'          => 'hidden',
-                'label'          => esc_html__('No label', 'event_espresso'),
-                'name'           => $input_key,
-                'options'        => [],
-                'required'       => false,
-                'tabindex'       => 0,
-                'rows'           => 10,
-                'type'           => 'int',
-                'validation'     => true,
-                'value'          => 'some_value_for_field',
-            ];
-
-            $input_value = wp_parse_args($input_value, $defaults);
-
-            $append_content = $input_value['append_content'];
-            $css_class      = $input_value['css_class'];
-            $cols           = $input_value['cols'];
-            $label          = $input_value['label'];
-            $name           = $input_value['name'];
-            $options        = $input_value['options'];
-            $required       = $input_value['required'];
-            $tab_index      = $input_value['tabindex'];
-            $rows           = $input_value['rows'];
-            $type           = $input_value['input'];
-            $value          = $input_value['value'];
-
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
-
-            // what type of input are we dealing with ?
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    $field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'hidden':
-                    $field           = null;
-                    $hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = is_array($options) ? $options : explode(',', $options);
-                    $field   = self::adminLabel($id, $label, $required);
-                    $field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
-                    $field   .= $append_content ?: '';
-                    break;
-
-                case 'textarea':
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'wp_editor':
-                    $label = esc_html($label);
-                    $field = "<h4>{$label}</h4>";
-                    $field .= $append_content ?: '';
-                    $field .= self::adminWpEditor(
-                        $class,
-                        $id,
-                        $name,
-                        $rows,
-                        $tab_index,
-                        $value
-                    );
-                    break;
-
-                default:
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
-                    $field .= $append_content ?: '';
-            }
-            if ($field) {
-                $inputs[] = $field;
-            }
-        } // end foreach( $input_vars as $input_key => $input_value )
-
-        if (! empty($inputs)) {
-            $glue   = "
+	/**
+	 *  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' => esc_html__('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 $form_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 = [], $form_id = false)
+	{
+
+		if (empty($input_vars)) {
+			EE_Error::add_error(
+				esc_html__('missing required variables for the form field generator', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$output        = "";
+		$inputs        = [];
+		$hidden_inputs = [];
+
+		// cycle thru inputs
+		foreach ($input_vars as $input_key => $input_value) {
+			$defaults = [
+				'append_content' => '',
+				'css_class'      => '',
+				'cols'           => 80,
+				'db-col'         => 'column_in_db',
+				'format'         => '%d',
+				'input'          => 'hidden',
+				'label'          => esc_html__('No label', 'event_espresso'),
+				'name'           => $input_key,
+				'options'        => [],
+				'required'       => false,
+				'tabindex'       => 0,
+				'rows'           => 10,
+				'type'           => 'int',
+				'validation'     => true,
+				'value'          => 'some_value_for_field',
+			];
+
+			$input_value = wp_parse_args($input_value, $defaults);
+
+			$append_content = $input_value['append_content'];
+			$css_class      = $input_value['css_class'];
+			$cols           = $input_value['cols'];
+			$label          = $input_value['label'];
+			$name           = $input_value['name'];
+			$options        = $input_value['options'];
+			$required       = $input_value['required'];
+			$tab_index      = $input_value['tabindex'];
+			$rows           = $input_value['rows'];
+			$type           = $input_value['input'];
+			$value          = $input_value['value'];
+
+			$id    = $form_id ? $form_id . '-' . $input_key : $input_key;
+			$class = $required ? 'required ' . $css_class : $css_class;
+
+			// what type of input are we dealing with ?
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					$field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'hidden':
+					$field           = null;
+					$hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = is_array($options) ? $options : explode(',', $options);
+					$field   = self::adminLabel($id, $label, $required);
+					$field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
+					$field   .= $append_content ?: '';
+					break;
+
+				case 'textarea':
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'wp_editor':
+					$label = esc_html($label);
+					$field = "<h4>{$label}</h4>";
+					$field .= $append_content ?: '';
+					$field .= self::adminWpEditor(
+						$class,
+						$id,
+						$name,
+						$rows,
+						$tab_index,
+						$value
+					);
+					break;
+
+				default:
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
+					$field .= $append_content ?: '';
+			}
+			if ($field) {
+				$inputs[] = $field;
+			}
+		} // end foreach( $input_vars as $input_key => $input_value )
+
+		if (! empty($inputs)) {
+			$glue   = "
                 </li>
                 <li>
                     ";
-            $inputs = implode($glue, $inputs);
-            $output = "
+			$inputs = implode($glue, $inputs);
+			$output = "
             <ul>
                 <li>
                 {$inputs}
                 </li>
             </ul>
             ";
-        }
-        return $output . implode("\n", $hidden_inputs);
-    }
-
-
-    /**
-     * 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 = [];
-        $fields      = (array) $fields;
-
-        foreach ($fields as $field_name => $field_atts) {
-            // defaults:
-            $defaults = [
-                'class'         => '',
-                'classes'       => '',
-                'default'       => '',
-                'dimensions'    => ['10', '5'],
-                'extra_desc'    => '',
-                'id'            => $field_name,
-                'label'         => '',
-                'labels'        => '',
-                'required'      => false,
-                'tabindex'      => 0,
-                'type'          => 'text',
-                'unique_id'     => '',
-                'value'         => '',
-                'wpeditor_args' => [],
-            ];
-            // merge defaults with passed arguments
-            $_fields = wp_parse_args($field_atts, $defaults);
-
-            $class          = $_fields['class'];
-            $classes        = $_fields['classes'];
-            $default        = $_fields['default'];
-            $dims           = $_fields['dimensions'];
-            $extra_desc     = $_fields['extra_desc'];
-            $id             = $_fields['id'];
-            $label          = $_fields['label'];
-            $labels         = $_fields['labels'];
-            $required       = $_fields['required'];
-            $tab_index      = $_fields['tabindex'];
-            $type           = $_fields['type'];
-            $unique_id      = $_fields['unique_id'];
-            $value          = $_fields['value'];
-            $wp_editor_args = $_fields['wpeditor_args'];
-
-            // generate label
-            $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
-            // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
-
-            // we determine what we're building based on the type
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    if (is_array($value)) {
-                        $c_input = '';
-                        foreach ($value as $key => $val) {
-                            $c_input .= self::adminMulti(
-                                $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
-                                $name,
-                                $required,
-                                $tab_index,
-                                $type,
-                                $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
-                            );
-                        }
-                        $field = $c_input;
-                    } else {
-                        $field = self::adminMulti(
-                            $default,
-                            $class,
-                            $id,
-                            $name,
-                            $required,
-                            $tab_index,
-                            $type,
-                            $value,
-                            $_fields['label']
-                        );
-                    }
-                    break;
-
-                case 'hidden':
-                    $field = self::adminHidden($class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = [];
-                    foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
-                    }
-                    $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
-                    break;
-
-                case 'textarea':
-                    $field =
-                        self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
-                    break;
-
-                case 'wp_editor':
-                    $field = self::adminWpEditor(
-                        $class,
-                        $_fields['id'],
-                        $name,
-                        $dims[1],
-                        $tab_index,
-                        $value,
-                        $wp_editor_args
-                    );
-                    break;
-
-                default:
-                    $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
-            }
-
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
-        }
-
-        return $form_fields;
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminHidden($class, $id, $name, $value)
-    {
-        $id    = esc_attr($id);
-        $name  = esc_attr($name);
-        $class = esc_attr($class);
-        return "
+		}
+		return $output . implode("\n", $hidden_inputs);
+	}
+
+
+	/**
+	 * 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 = [];
+		$fields      = (array) $fields;
+
+		foreach ($fields as $field_name => $field_atts) {
+			// defaults:
+			$defaults = [
+				'class'         => '',
+				'classes'       => '',
+				'default'       => '',
+				'dimensions'    => ['10', '5'],
+				'extra_desc'    => '',
+				'id'            => $field_name,
+				'label'         => '',
+				'labels'        => '',
+				'required'      => false,
+				'tabindex'      => 0,
+				'type'          => 'text',
+				'unique_id'     => '',
+				'value'         => '',
+				'wpeditor_args' => [],
+			];
+			// merge defaults with passed arguments
+			$_fields = wp_parse_args($field_atts, $defaults);
+
+			$class          = $_fields['class'];
+			$classes        = $_fields['classes'];
+			$default        = $_fields['default'];
+			$dims           = $_fields['dimensions'];
+			$extra_desc     = $_fields['extra_desc'];
+			$id             = $_fields['id'];
+			$label          = $_fields['label'];
+			$labels         = $_fields['labels'];
+			$required       = $_fields['required'];
+			$tab_index      = $_fields['tabindex'];
+			$type           = $_fields['type'];
+			$unique_id      = $_fields['unique_id'];
+			$value          = $_fields['value'];
+			$wp_editor_args = $_fields['wpeditor_args'];
+
+			// generate label
+			$label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
+			// generate field name
+			$name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+
+			// we determine what we're building based on the type
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					if (is_array($value)) {
+						$c_input = '';
+						foreach ($value as $key => $val) {
+							$c_input .= self::adminMulti(
+								$default,
+								isset($classes[ $key ]) ? $classes[ $key ] : '',
+								$field_name . '_' . $value,
+								$name,
+								$required,
+								$tab_index,
+								$type,
+								$val,
+								isset($labels[ $key ]) ? $labels[ $key ] : ''
+							);
+						}
+						$field = $c_input;
+					} else {
+						$field = self::adminMulti(
+							$default,
+							$class,
+							$id,
+							$name,
+							$required,
+							$tab_index,
+							$type,
+							$value,
+							$_fields['label']
+						);
+					}
+					break;
+
+				case 'hidden':
+					$field = self::adminHidden($class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = [];
+					foreach ($value as $key => $val) {
+						$options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+					}
+					$field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
+					break;
+
+				case 'textarea':
+					$field =
+						self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
+					break;
+
+				case 'wp_editor':
+					$field = self::adminWpEditor(
+						$class,
+						$_fields['id'],
+						$name,
+						$dims[1],
+						$tab_index,
+						$value,
+						$wp_editor_args
+					);
+					break;
+
+				default:
+					$field = self::adminText($class, $id, $name, $required, $tab_index, $value);
+			}
+
+			$form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+		}
+
+		return $form_fields;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminHidden($class, $id, $name, $value)
+	{
+		$id    = esc_attr($id);
+		$name  = esc_attr($name);
+		$class = esc_attr($class);
+		return "
         <input name='{$name}' type='hidden' id='{$id}' class='{$class}' value='{$value}' />";
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $label
-     * @param string $required
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminLabel($id, $label, $required)
-    {
-        $id       = esc_attr($id);
-        $label    = esc_html($label);
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
-        return "<label for='{$id}'>{$label}{$required}</label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $type
-     * @param string $value
-     * @param string $label
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $tab_index = absint($tab_index);
-        $checked   = ! empty($default) && $default == $value ? 'checked ' : '';
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        $input     = "
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $label
+	 * @param string $required
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminLabel($id, $label, $required)
+	{
+		$id       = esc_attr($id);
+		$label    = esc_html($label);
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
+		return "<label for='{$id}'>{$label}{$required}</label>";
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $type
+	 * @param string $value
+	 * @param string $label
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$tab_index = absint($tab_index);
+		$checked   = ! empty($default) && $default == $value ? 'checked ' : '';
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		$input     = "
         <input name='{$name}[]' type='{$type}' id='{$id}' class='{$class}' value='{$value}' {$checked} {$required} tabindex='{$tab_index}'/>";
-        if ($label === '') {
-            return $input;
-        }
-        $label = esc_html($label);
-        $label_class = self::appendInputSizeClass('', $label);
-        $label_class = $label_class ? ' class="' . $label_class . '"' : '';
-        return "
+		if ($label === '') {
+			return $input;
+		}
+		$label = esc_html($label);
+		$label_class = self::appendInputSizeClass('', $label);
+		$label_class = $label_class ? ' class="' . $label_class . '"' : '';
+		return "
         <label for='$id'{$label_class}>
             {$input}
             {$label}
         </label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param array  $options
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
-    {
-        $options_array = [];
-        foreach ($options as $value => $label) {
-            $selected        = ! empty($default) && $default == $value ? 'selected' : '';
-            $value           = esc_attr($value);
-            $label           = wp_strip_all_tags($label);
-            $options_array[] = "<option value='{$value}' {$selected}>{$label}</option>";
-        }
-        $options_html = implode("\n", $options_array);
-        $id           = esc_attr($id);
-        $name         = esc_attr($name);
-        $class        = esc_attr($class);
-        $tab_index    = absint($tab_index);
-        $required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-
-        $class = self::appendInputSizeClass($class, $options);
-
-        return "
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param array  $options
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
+	{
+		$options_array = [];
+		foreach ($options as $value => $label) {
+			$selected        = ! empty($default) && $default == $value ? 'selected' : '';
+			$value           = esc_attr($value);
+			$label           = wp_strip_all_tags($label);
+			$options_array[] = "<option value='{$value}' {$selected}>{$label}</option>";
+		}
+		$options_html = implode("\n", $options_array);
+		$id           = esc_attr($id);
+		$name         = esc_attr($name);
+		$class        = esc_attr($class);
+		$tab_index    = absint($tab_index);
+		$required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+
+		$class = self::appendInputSizeClass($class, $options);
+
+		return "
         <select name='{$name}' id='{$id}' class='{$class}' {$required} tabindex='{$tab_index}'>
             {$options_html}
         </select>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminText($class, $id, $name, $required, $tab_index, $value)
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $tab_index = absint($tab_index);
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        $class     = self::appendInputSizeClass($class, $value);
-        $value     = esc_attr($value);
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminText($class, $id, $name, $required, $tab_index, $value)
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$tab_index = absint($tab_index);
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		$class     = self::appendInputSizeClass($class, $value);
+		$value     = esc_attr($value);
+		return "
         <input name='{$name}' type='text' id='{$id}' class='{$class}' value='{$value}' {$required} tabindex='{$tab_index}'/>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param int    $cols
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $cols      = absint($cols);
-        $rows      = absint($rows);
-        $value     = esc_textarea($value);
-        $tab_index = absint($tab_index);
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param int    $cols
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$cols      = absint($cols);
+		$rows      = absint($rows);
+		$value     = esc_textarea($value);
+		$tab_index = absint($tab_index);
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <textarea name='{$name}' id='{$id}' class='{$class}' rows='{$rows}' cols='{$cols}' {$required} tabindex='{$tab_index}'>{$value}</textarea>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @param array  $wp_editor_args
-     * @return false|string
-     * @since   4.10.14.p
-     */
-    private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
-    {
-        $editor_settings = $wp_editor_args + [
-                'textarea_name' => esc_attr($name),
-                'textarea_rows' => absint($rows),
-                'editor_class'  => esc_attr($class),
-                'tabindex'      => absint($tab_index),
-            ];
-        ob_start();
-        wp_editor($value, esc_attr($id), $editor_settings);
-        return ob_get_clean();
-    }
-
-
-    /**
-     * 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 parameters
-     * @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 = [];
-            foreach ($values as $id => $text) {
-                $converted_values[] = ['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)
-            . '"';
-
-        if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
-        }
-        $class = $autosize ? self::appendInputSizeClass($class, $values) : '';
-
-        $field .= ' class="' . $class . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-        $field .= self::selectInputOption($values, $default);
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-    private static function selectInputOption(array $values, $default): string
-    {
-        if (isset($values['id'], $values['text'])) {
-            $id = is_scalar($values['id']) ? $values['id'] : '';
-            $text = is_scalar($values['text']) ? $values['text'] : '';
-            $selected = $default == $values['id'] ? ' selected = "selected"' : '';
-            $html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
-            return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
-        }
-        $options = '';
-        foreach ($values as $value) {
-            $options .= self::selectInputOption($value, $default);
-        }
-        return $options;
-    }
-
-
-    /**
-     * @param mixed $value
-     * @return int
-     * @since   $VID:$
-     */
-    private static function getInputValueLength($value): int
-    {
-        if ($value instanceof EE_Question_Option) {
-            return self::getInputValueLength($value->desc());
-        }
-        if (is_array($value)) {
-            $chars = 0;
-            foreach ($value as $val) {
-                $length = self::getInputValueLength($val);
-                $chars = max($length, $chars);
-            }
-            return $chars;
-        }
-        // not a primitive? return something big
-        if (! is_scalar($value)) {
-            return 500;
-        }
-        return strlen((string) $value);
-    }
-
-
-    /**
-     * @param string $class
-     * @param mixed $value
-     * @return string
-     * @since   $VID:$
-     */
-    private static function appendInputSizeClass(string $class, $value): string
-    {
-        if (strpos($class, 'ee-input-width--') !== false) {
-            return $class;
-        }
-        $chars = self::getInputValueLength($value);
-        if ($chars && $chars < 5) {
-            return "{$class} ee-input-width--tiny";
-        }
-        if ($chars && $chars < 25) {
-            return "{$class} ee-input-width--small";
-        }
-        if ($chars && $chars > 100) {
-            return "{$class} ee-input-width--big";
-        }
-        return "{$class} ee-input-width--reg";
-    }
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array  $question_groups
-     * @param string $group_wrapper
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html($question_groups = [], $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)) {
-            // 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) {
-                        $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html2(
-        $question_groups = [],
-        $q_meta = [],
-        $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 = [
-            'att_nmbr'    => 1,
-            'ticket_id'   => '',
-            'input_name'  => '',
-            'input_id'    => '',
-            'input_class' => '',
-        ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
-
-        if (! empty($question_groups)) {
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                if ($QSG instanceof EE_Question_Group) {
-                    // check that questions exist
-
-                    $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
-                        $where['QST_admin_only'] = 0;
-                    }
-                    $questions =
-                        $QSG->questions([$where, 'order_by' => ['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;
-
-                            /** @var RequestInterface $request */
-                            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-                            $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
-                                // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_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(
-                                    [
-                                        'ANS_ID'    => 0,
-                                        'QST_ID'    => 0,
-                                        'REG_ID'    => 0,
-                                        'ANS_value' => $answer,
-                                    ]
-                                ),
-                                $q_meta
-                            );
-                            $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_form_input(EE_Question_Form_Input $QFI)
-    {
-        if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
-            return '';
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        $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       = $request->getRequestParam($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');
-        $required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
-        $QST_required      = $QFI->get('QST_required');
-        $required          =
-            $QST_required
-                ? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
-                : [];
-        $use_html_entities = $QFI->get_meta('htmlentities');
-        $required_text     =
-            $QFI->get('QST_required_text') != ''
-                ? $QFI->get('QST_required_text')
-                : esc_html__('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       = $QFI->get('label_class');
-        $label_class       = $label_class ? "{$label_class} espresso-form-input-lbl" : 'espresso-form-input-lbl';
-        $QST_options       = $QFI->options(true, $answer);
-        $options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
-        $system_ID         = $QFI->get('QST_system');
-        $label_b4          = $QFI->get_meta('label_b4');
-        $use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
-        $add_mobile_label  = $QFI->get_meta('add_mobile_label');
-
-
-        switch ($QFI->get('QST_type')) {
-            case 'TEXTAREA':
-                return EEH_Form_Fields::textarea(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    [],
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-
-
-            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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-        }
-    }
-
-
-    public static function label(
-        string $question,
-        string $required_text = '',
-        string $required_label = '',
-        string $name = '',
-        string $label_class = '',
-        bool $filter = true
-    ): string {
-        $for   = ! empty($name) ? " for='{$name}'" : '';
-        $class = ! empty($label_class) ? " class='{$label_class}'" : '';
-        $label = self::prep_question($question) . $required_label;
-        $label_html = "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @param array  $wp_editor_args
+	 * @return false|string
+	 * @since   4.10.14.p
+	 */
+	private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
+	{
+		$editor_settings = $wp_editor_args + [
+				'textarea_name' => esc_attr($name),
+				'textarea_rows' => absint($rows),
+				'editor_class'  => esc_attr($class),
+				'tabindex'      => absint($tab_index),
+			];
+		ob_start();
+		wp_editor($value, esc_attr($id), $editor_settings);
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * 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 parameters
+	 * @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 = [];
+			foreach ($values as $id => $text) {
+				$converted_values[] = ['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)
+			. '"';
+
+		if (EEH_Formatter::ee_tep_not_null($parameters)) {
+			$field .= ' ' . $parameters;
+		}
+		$class = $autosize ? self::appendInputSizeClass($class, $values) : '';
+
+		$field .= ' class="' . $class . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+		$field .= self::selectInputOption($values, $default);
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+	private static function selectInputOption(array $values, $default): string
+	{
+		if (isset($values['id'], $values['text'])) {
+			$id = is_scalar($values['id']) ? $values['id'] : '';
+			$text = is_scalar($values['text']) ? $values['text'] : '';
+			$selected = $default == $values['id'] ? ' selected = "selected"' : '';
+			$html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
+			return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
+		}
+		$options = '';
+		foreach ($values as $value) {
+			$options .= self::selectInputOption($value, $default);
+		}
+		return $options;
+	}
+
+
+	/**
+	 * @param mixed $value
+	 * @return int
+	 * @since   $VID:$
+	 */
+	private static function getInputValueLength($value): int
+	{
+		if ($value instanceof EE_Question_Option) {
+			return self::getInputValueLength($value->desc());
+		}
+		if (is_array($value)) {
+			$chars = 0;
+			foreach ($value as $val) {
+				$length = self::getInputValueLength($val);
+				$chars = max($length, $chars);
+			}
+			return $chars;
+		}
+		// not a primitive? return something big
+		if (! is_scalar($value)) {
+			return 500;
+		}
+		return strlen((string) $value);
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param mixed $value
+	 * @return string
+	 * @since   $VID:$
+	 */
+	private static function appendInputSizeClass(string $class, $value): string
+	{
+		if (strpos($class, 'ee-input-width--') !== false) {
+			return $class;
+		}
+		$chars = self::getInputValueLength($value);
+		if ($chars && $chars < 5) {
+			return "{$class} ee-input-width--tiny";
+		}
+		if ($chars && $chars < 25) {
+			return "{$class} ee-input-width--small";
+		}
+		if ($chars && $chars > 100) {
+			return "{$class} ee-input-width--big";
+		}
+		return "{$class} ee-input-width--reg";
+	}
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array  $question_groups
+	 * @param string $group_wrapper
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html($question_groups = [], $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)) {
+			// 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) {
+						$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html2(
+		$question_groups = [],
+		$q_meta = [],
+		$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 = [
+			'att_nmbr'    => 1,
+			'ticket_id'   => '',
+			'input_name'  => '',
+			'input_id'    => '',
+			'input_class' => '',
+		];
+		$q_meta         = array_merge($default_q_meta, $q_meta);
+
+		if (! empty($question_groups)) {
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				if ($QSG instanceof EE_Question_Group) {
+					// check that questions exist
+
+					$where = ['QST_deleted' => 0];
+					if (! $from_admin) {
+						$where['QST_admin_only'] = 0;
+					}
+					$questions =
+						$QSG->questions([$where, 'order_by' => ['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;
+
+							/** @var RequestInterface $request */
+							$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+							$request_qstn = $request->getRequestParam('qstn', [], 'string', true);
+							if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+								// check for answer in $request_qstn in case we are reprocessing a form after an error
+								if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
+									$answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
+										? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
+										: sanitize_text_field($request_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(
+									[
+										'ANS_ID'    => 0,
+										'QST_ID'    => 0,
+										'REG_ID'    => 0,
+										'ANS_value' => $answer,
+									]
+								),
+								$q_meta
+							);
+							$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_form_input(EE_Question_Form_Input $QFI)
+	{
+		if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
+			return '';
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		$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       = $request->getRequestParam($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');
+		$required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
+		$QST_required      = $QFI->get('QST_required');
+		$required          =
+			$QST_required
+				? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
+				: [];
+		$use_html_entities = $QFI->get_meta('htmlentities');
+		$required_text     =
+			$QFI->get('QST_required_text') != ''
+				? $QFI->get('QST_required_text')
+				: esc_html__('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       = $QFI->get('label_class');
+		$label_class       = $label_class ? "{$label_class} espresso-form-input-lbl" : 'espresso-form-input-lbl';
+		$QST_options       = $QFI->options(true, $answer);
+		$options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
+		$system_ID         = $QFI->get('QST_system');
+		$label_b4          = $QFI->get_meta('label_b4');
+		$use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
+		$add_mobile_label  = $QFI->get_meta('add_mobile_label');
+
+
+		switch ($QFI->get('QST_type')) {
+			case 'TEXTAREA':
+				return EEH_Form_Fields::textarea(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					[],
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+
+
+			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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+		}
+	}
+
+
+	public static function label(
+		string $question,
+		string $required_text = '',
+		string $required_label = '',
+		string $name = '',
+		string $label_class = '',
+		bool $filter = true
+	): string {
+		$for   = ! empty($name) ? " for='{$name}'" : '';
+		$class = ! empty($label_class) ? " class='{$label_class}'" : '';
+		$label = self::prep_question($question) . $required_label;
+		$label_html = "
             {$required_text}
             <label{$for}{$class}>{$label}</label>";
-        // filter label but ensure required text comes before it
-        return $filter
-            ? apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text)
-            : $label_html;
-    }
-
-
-
-    public static function mobileLabel(
-        bool $add_mobile_label,
-        string $question,
-        string $required_text = '',
-        string $required_label = '',
-        string $label_class = '',
-        string $name = ''
-    ): string {
-        return $add_mobile_label
-            ? self::label($question, $required_text, $required_label, $name, $label_class, false)
-            : '';
-    }
-
-
-    /**
-     * 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,
-        $add_mobile_label = false,
-        $extra_attributes = ''
-    ) {
-        // 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 : '';
-        $class = self::appendInputSizeClass($class, $answer);
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
-
-        $label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label . '
+		// filter label but ensure required text comes before it
+		return $filter
+			? apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text)
+			: $label_html;
+	}
+
+
+
+	public static function mobileLabel(
+		bool $add_mobile_label,
+		string $question,
+		string $required_text = '',
+		string $required_label = '',
+		string $label_class = '',
+		string $name = ''
+	): string {
+		return $add_mobile_label
+			? self::label($question, $required_text, $required_label, $name, $label_class, false)
+			: '';
+	}
+
+
+	/**
+	 * 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,
+		$add_mobile_label = false,
+		$extra_attributes = ''
+	) {
+		// 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 : '';
+		$class = self::appendInputSizeClass($class, $answer);
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+		$extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
+
+		$label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label . '
             <input  type="text"
                     name="' . $name . '"
                     id="' . $id . '"
@@ -1088,1039 +1088,1039 @@ 
                     ' . $disabled . ' ' . $extra_attributes . '
             />';
 
-        $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,
-        $add_mobile_label = false
-    ) {
-        // 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 : [];
-        // and set some defaults
-        $dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
-             . esc_textarea($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,
-        $add_mobile_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(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!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class = self::appendInputSizeClass($class, $options);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
-            . 'aria-label="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
-        // recursively count array elements, to determine total number of options
-        $only_option = count($options, 1) == 1;
-        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' : '';
-            $input_html .= $add_please_select_option
-                ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
-                  . esc_html__(' - 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' : '';
-        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,
-        $add_mobile_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 = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class
-        );
-
-        $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $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' : '';
-                $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>&nbsp;' : '';
-                $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4
-                    ? "\n\t\t\t\t\t\t"
-                      . '&nbsp;<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,
-        $add_mobile_label = false
-    ) {
-        // 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 : [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   = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class
-        );
-
-        $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $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' : '';
-
-            $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>&nbsp;' : '';
-            $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;<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,
-        $add_mobile_label = false
-    ) {
-        // 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 : '';
-        $class = self::appendInputSizeClass($class, $answer);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'aria-label="' . 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',
-            [],
-            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 returns the 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;
-    }
-
-
-    /**
-     *  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 = [])
-    {
-        $prepped_answer_options = [];
-        if (is_array($QSOs) && ! empty($QSOs)) {
-            foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            '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 = [])
-    {
-        // make sure required is an array
-        $required = is_array($required) ? $required : [];
-        // and set some defaults
-        return array_merge(['label' => '', 'class' => '', 'msg' => ''], $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 EE_Question_Form_Input $QFI
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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.
-     *
-     * @param EE_Question_Form_Input $QFI
-     *
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.6.0
-     */
-    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 EE_Question_Form_Input $QST
-     * @param bool                   $get_all
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 ($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(
-                        [
-                            '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
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @internal param array $question
-     */
-    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(
-                        [
-                            '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 = [];
-        for ($x = 1; $x <= 12; $x++) {
-            $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-    /**
-     *  generates a year dropdown selector with numbers for the next ten years
-     *
-     * @return array
-     */
-    public static function next_decade_two_digit_year_dropdown_options()
-    {
-        $options      = [];
-        $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[ $yy ] = $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
-     * @throws EE_Error
-     */
-    public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
-    {
-        $_where = [];
-        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 = [
-            0 => [
-                'text' => esc_html__('Select a Month/Year', 'event_espresso'),
-                'id'   => '',
-            ],
-        ];
-
-        foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
-            $options[] = [
-                'text' => $date,
-                'id'   => $date,
-            ];
-        }
-
-        return self::select_input('month_range', $options, $cur_date);
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     */
-    public static function generate_event_months_dropdown(
-        $cur_date = '',
-        $status = null,
-        $evt_category = null,
-        $evt_active_status = null
-    ) {
-        // 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'] = ['NOT IN', ['trash']];
-                break;
-            case 'draft':
-                $where['Event.status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['Event.status'] = $status;
-        }
-
-        // phpcs:enable
-
-        // categories?
-
-
-        if (! empty($evt_category) and $evt_category > 0) {
-            $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Event.Term_Taxonomy.term_id']  = $evt_category;
-        }
-
-
-        //      $where['DTT_is_primary'] = 1;
-
-        $DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
-
-        // let's setup vals for select input helper
-        $options = [
-            0 => [
-                'text' => esc_html__('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[]      = [
-                'text' => $localized_date,
-                'id'   => $id,
-            ];
-        }
-
-
-        return self::select_input('month_range', $options, $cur_date);
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_event_category_dropdown($current_cat = -1)
-    {
-        $categories = EEM_Term::instance()->get_all_ee_categories(true);
-        $options    = [
-            '0' => [
-                'text' => esc_html__('All Categories', 'event_espresso'),
-                'id'   => -1,
-            ],
-        ];
-
-        // setup categories for dropdown
-        foreach ($categories as $category) {
-            $options[] = [
-                '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    string
-     */
-    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 : esc_html__('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;
-    }
+		$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,
+		$add_mobile_label = false
+	) {
+		// 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 : [];
+		// and set some defaults
+		$dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
+			. 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
+			. 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+			 . esc_textarea($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,
+		$add_mobile_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(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!!!
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class = self::appendInputSizeClass($class, $options);
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
+			. 'aria-label="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+		// recursively count array elements, to determine total number of options
+		$only_option = count($options, 1) == 1;
+		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' : '';
+			$input_html .= $add_please_select_option
+				? "\n\t\t\t\t"
+				  . '<option value=""' . $selected . '>'
+				  . esc_html__(' - 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' : '';
+		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,
+		$add_mobile_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 = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class
+		);
+
+		$input_html = $mobile_label
+			. '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $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' : '';
+				$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>&nbsp;' : '';
+				$input_html .= "\n\t\t\t\t\t\t"
+							   . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
+							   . 'class="' . $class . '" value="' . $value . '" '
+							   . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
+							   . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4
+					? "\n\t\t\t\t\t\t"
+					  . '&nbsp;<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,
+		$add_mobile_label = false
+	) {
+		// 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 : [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   = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class
+		);
+
+		$input_html = $mobile_label
+			. '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $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' : '';
+
+			$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>&nbsp;' : '';
+			$input_html .= "\n\t\t\t\t\t\t"
+						   . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
+						   . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
+						   . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;<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,
+		$add_mobile_label = false
+	) {
+		// 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 : '';
+		$class = self::appendInputSizeClass($class, $answer);
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
+			. 'aria-label="' . 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',
+			[],
+			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 returns the 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;
+	}
+
+
+	/**
+	 *  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 = [])
+	{
+		$prepped_answer_options = [];
+		if (is_array($QSOs) && ! empty($QSOs)) {
+			foreach ($QSOs as $key => $QSO) {
+				if (! $QSO instanceof EE_Question_Option) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'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 = [])
+	{
+		// make sure required is an array
+		$required = is_array($required) ? $required : [];
+		// and set some defaults
+		return array_merge(['label' => '', 'class' => '', 'msg' => ''], $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 EE_Question_Form_Input $QFI
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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.
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 *
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.6.0
+	 */
+	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 EE_Question_Form_Input $QST
+	 * @param bool                   $get_all
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 ($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(
+						[
+							'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
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @internal param array $question
+	 */
+	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(
+						[
+							'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 = [];
+		for ($x = 1; $x <= 12; $x++) {
+			$mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ $mm ] = $mm;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+	/**
+	 *  generates a year dropdown selector with numbers for the next ten years
+	 *
+	 * @return array
+	 */
+	public static function next_decade_two_digit_year_dropdown_options()
+	{
+		$options      = [];
+		$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[ $yy ] = $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
+	 * @throws EE_Error
+	 */
+	public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
+	{
+		$_where = [];
+		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 = [
+			0 => [
+				'text' => esc_html__('Select a Month/Year', 'event_espresso'),
+				'id'   => '',
+			],
+		];
+
+		foreach ($regdtts as $regdtt) {
+			$date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+			$options[] = [
+				'text' => $date,
+				'id'   => $date,
+			];
+		}
+
+		return self::select_input('month_range', $options, $cur_date);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 */
+	public static function generate_event_months_dropdown(
+		$cur_date = '',
+		$status = null,
+		$evt_category = null,
+		$evt_active_status = null
+	) {
+		// 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'] = ['NOT IN', ['trash']];
+				break;
+			case 'draft':
+				$where['Event.status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['Event.status'] = $status;
+		}
+
+		// phpcs:enable
+
+		// categories?
+
+
+		if (! empty($evt_category) and $evt_category > 0) {
+			$where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Event.Term_Taxonomy.term_id']  = $evt_category;
+		}
+
+
+		//      $where['DTT_is_primary'] = 1;
+
+		$DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
+
+		// let's setup vals for select input helper
+		$options = [
+			0 => [
+				'text' => esc_html__('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[]      = [
+				'text' => $localized_date,
+				'id'   => $id,
+			];
+		}
+
+
+		return self::select_input('month_range', $options, $cur_date);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_event_category_dropdown($current_cat = -1)
+	{
+		$categories = EEM_Term::instance()->get_all_ee_categories(true);
+		$options    = [
+			'0' => [
+				'text' => esc_html__('All Categories', 'event_espresso'),
+				'id'   => -1,
+			],
+		];
+
+		// setup categories for dropdown
+		foreach ($categories as $category) {
+			$options[] = [
+				'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    string
+	 */
+	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 : esc_html__('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;
+	}
 }

caffeinated/admin/new/pricing/Prices_List_Table.class.php

Indentation +270 added lines, -270 removed lines

@@ -13,274 +13,274 @@
  */
 class Prices_List_Table extends EE_Admin_List_Table
 {
-    private $_PRT;
-
-    /**
-     * Array of price types.
-     *
-     * @var EE_Price_Type[]
-     */
-    protected $_price_types = [];
-
-
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->_PRT         = EEM_Price_Type::instance();
-        $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
-    }
-
-
-    protected function _setup_data()
-    {
-        $trashed               = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data           = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
-        $this->_trashed_count  = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = [
-            'singular' => esc_html__('price', 'event_espresso'),
-            'plural'   => esc_html__('prices', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        ];
-
-        $this->_columns = [
-            'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
-            'id'          => esc_html__('ID', 'event_espresso'),
-            'name'        => esc_html__('Name', 'event_espresso'),
-            'type'        => esc_html__('Price Type', 'event_espresso'),
-            'description' => esc_html__('Description', 'event_espresso'),
-            'amount'      => esc_html__('Amount', 'event_espresso'),
-        ];
-        $this->_primary_column = 'id';
-
-        $this->_sortable_columns = [
-            // true means its already sorted
-            'name'   => ['name' => false],
-            'type'   => ['type' => false],
-            'amount' => ['amount' => false],
-        ];
-
-        $this->_hidden_columns = [];
-
-        $this->_ajax_sorting_callback = 'update_prices_order';
-    }
-
-
-    protected function _get_table_filters()
-    {
-        return [];
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    /**
-     * overriding parent method so that we can make sure the row isn't sortable for certain items
-     *
-     * @param object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        return $item->type_obj() instanceof EE_Price_Type
-                     && $item->type_obj()->base_type() !== 1
-                     && $item->type_obj()->base_type() !== 4
-            ? ' class="rowsortable"'
-            : '';
-    }
-
-
-    /**
-     * @param EE_Price $price
-     * @param string   $action
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    protected function getActionUrl(EE_Price $price, string $action): string
-    {
-        if (! in_array($action, self::$actions)) {
-            throw new DomainException(esc_html__('Invalid Action', 'event_espresso'));
-        }
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'   => "{$action}_price",
-                'id'       => $price->ID(),
-                'noheader' => $action !== self::ACTION_EDIT,
-            ],
-            PRICING_ADMIN_URL
-        );
-    }
-
-
-    public function column_cb($item)
-    {
-        return $item->type_obj() instanceof EE_Price_Type && $item->type_obj()->base_type() !== 1
-            ? sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            )
-            : '';
-    }
-
-
-    /**
-     * @param EE_Price $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_id($item)
-    {
-        $content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">' . $this->column_name($item, false) . '</span>';
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Price $price
-     * @param bool     $prep_content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_name(EE_Price $price, bool $prep_content = true): string
-    {
-
-        // Build row actions
-        $actions = [];
-        // edit price link
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_default_price',
-                'pricing_edit_price',
-                $price->ID()
-            )
-        ) {
-            $actions['edit'] = $this->getActionLink(
-                $this->getActionUrl($price, self::ACTION_EDIT),
-                esc_html__('Edit', 'event_espresso'),
-                esc_attr__('Edit Price', 'event_espresso')
-            );
-        }
-
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'edit_price',
-            $price->ID()
-        )
-            ? $this->getActionLink(
-                $this->getActionUrl($price, self::ACTION_EDIT),
-                stripslashes($price->name()),
-                esc_attr__('Edit Price', 'event_espresso')
-            )
-            : $price->name();
-
-        if ($price->type_obj() instanceof EE_Price_Type && $price->type_obj()->base_type() !== 1) {
-            if ($this->_view == 'all') {
-                // trash price link
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price',
-                        'pricing_trash_price',
-                        $price->ID()
-                    )
-                ) {
-                    $actions['trash'] = $this->getActionLink(
-                        $this->getActionUrl($price, self::ACTION_TRASH),
-                        esc_html__('Trash', 'event_espresso'),
-                        esc_attr__('Move Price to Trash', 'event_espresso')
-                    );
-                }
-            } else {
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price',
-                        'pricing_restore_price',
-                        $price->ID()
-                    )
-                ) {
-                    $actions['restore'] = $this->getActionLink(
-                        $this->getActionUrl($price, self::ACTION_RESTORE),
-                        esc_html__('Restore', 'event_espresso'),
-                        esc_attr__('Restore Price', 'event_espresso')
-                    );
-                }
-
-                // delete price link
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price',
-                        'pricing_delete_price',
-                        $price->ID()
-                    )
-                ) {
-                    $actions['delete'] = $this->getActionLink(
-                        $this->getActionUrl($price, self::ACTION_DELETE),
-                        esc_html__('Delete Permanently', 'event_espresso'),
-                        esc_attr__('Delete Price Permanently', 'event_espresso')
-                    );
-                }
-            }
-        }
-
-        $content = $prep_content ? $name_link . $this->row_actions($actions) : $name_link;
-        return $prep_content ? $this->columnContent('name', $content) : $content;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_type(EE_Price $price): string
-    {
-        $content = isset($this->_price_types[ $price->type() ])
-            ? $this->_price_types[ $price->type() ]->name()
-            : '';
-        return $this->columnContent('type', $content);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_description(EE_Price $price): string
-    {
-        $content = stripslashes($price->desc());
-        return $this->columnContent('description', $content);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_amount(EE_Price $price): string
-    {
-        $price_type = isset($this->_price_types[ $price->type() ])
-            ? $this->_price_types[ $price->type() ]
-            : null;
-        $content = $price_type instanceof EE_Price_Type && $price_type->is_percent() ?
-            '<div class="pad-amnt-rght">' . number_format($price->amount(), 1) . '%</div>'
-            : '<div class="pad-amnt-rght">' . EEH_Template::format_currency($price->amount()) . '</div>';
-        return $this->columnContent('amount', $content, 'end');
-    }
+	private $_PRT;
+
+	/**
+	 * Array of price types.
+	 *
+	 * @var EE_Price_Type[]
+	 */
+	protected $_price_types = [];
+
+
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		parent::__construct($admin_page);
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->_PRT         = EEM_Price_Type::instance();
+		$this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
+	}
+
+
+	protected function _setup_data()
+	{
+		$trashed               = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data           = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
+		$this->_trashed_count  = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = [
+			'singular' => esc_html__('price', 'event_espresso'),
+			'plural'   => esc_html__('prices', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		];
+
+		$this->_columns = [
+			'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
+			'id'          => esc_html__('ID', 'event_espresso'),
+			'name'        => esc_html__('Name', 'event_espresso'),
+			'type'        => esc_html__('Price Type', 'event_espresso'),
+			'description' => esc_html__('Description', 'event_espresso'),
+			'amount'      => esc_html__('Amount', 'event_espresso'),
+		];
+		$this->_primary_column = 'id';
+
+		$this->_sortable_columns = [
+			// true means its already sorted
+			'name'   => ['name' => false],
+			'type'   => ['type' => false],
+			'amount' => ['amount' => false],
+		];
+
+		$this->_hidden_columns = [];
+
+		$this->_ajax_sorting_callback = 'update_prices_order';
+	}
+
+
+	protected function _get_table_filters()
+	{
+		return [];
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	/**
+	 * overriding parent method so that we can make sure the row isn't sortable for certain items
+	 *
+	 * @param object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		return $item->type_obj() instanceof EE_Price_Type
+					 && $item->type_obj()->base_type() !== 1
+					 && $item->type_obj()->base_type() !== 4
+			? ' class="rowsortable"'
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Price $price
+	 * @param string   $action
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	protected function getActionUrl(EE_Price $price, string $action): string
+	{
+		if (! in_array($action, self::$actions)) {
+			throw new DomainException(esc_html__('Invalid Action', 'event_espresso'));
+		}
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'   => "{$action}_price",
+				'id'       => $price->ID(),
+				'noheader' => $action !== self::ACTION_EDIT,
+			],
+			PRICING_ADMIN_URL
+		);
+	}
+
+
+	public function column_cb($item)
+	{
+		return $item->type_obj() instanceof EE_Price_Type && $item->type_obj()->base_type() !== 1
+			? sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			)
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Price $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_id($item)
+	{
+		$content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
+		$content .= '<span class="show-on-mobile-view-only">' . $this->column_name($item, false) . '</span>';
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Price $price
+	 * @param bool     $prep_content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_name(EE_Price $price, bool $prep_content = true): string
+	{
+
+		// Build row actions
+		$actions = [];
+		// edit price link
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_default_price',
+				'pricing_edit_price',
+				$price->ID()
+			)
+		) {
+			$actions['edit'] = $this->getActionLink(
+				$this->getActionUrl($price, self::ACTION_EDIT),
+				esc_html__('Edit', 'event_espresso'),
+				esc_attr__('Edit Price', 'event_espresso')
+			);
+		}
+
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'edit_price',
+			$price->ID()
+		)
+			? $this->getActionLink(
+				$this->getActionUrl($price, self::ACTION_EDIT),
+				stripslashes($price->name()),
+				esc_attr__('Edit Price', 'event_espresso')
+			)
+			: $price->name();
+
+		if ($price->type_obj() instanceof EE_Price_Type && $price->type_obj()->base_type() !== 1) {
+			if ($this->_view == 'all') {
+				// trash price link
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price',
+						'pricing_trash_price',
+						$price->ID()
+					)
+				) {
+					$actions['trash'] = $this->getActionLink(
+						$this->getActionUrl($price, self::ACTION_TRASH),
+						esc_html__('Trash', 'event_espresso'),
+						esc_attr__('Move Price to Trash', 'event_espresso')
+					);
+				}
+			} else {
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price',
+						'pricing_restore_price',
+						$price->ID()
+					)
+				) {
+					$actions['restore'] = $this->getActionLink(
+						$this->getActionUrl($price, self::ACTION_RESTORE),
+						esc_html__('Restore', 'event_espresso'),
+						esc_attr__('Restore Price', 'event_espresso')
+					);
+				}
+
+				// delete price link
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price',
+						'pricing_delete_price',
+						$price->ID()
+					)
+				) {
+					$actions['delete'] = $this->getActionLink(
+						$this->getActionUrl($price, self::ACTION_DELETE),
+						esc_html__('Delete Permanently', 'event_espresso'),
+						esc_attr__('Delete Price Permanently', 'event_espresso')
+					);
+				}
+			}
+		}
+
+		$content = $prep_content ? $name_link . $this->row_actions($actions) : $name_link;
+		return $prep_content ? $this->columnContent('name', $content) : $content;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_type(EE_Price $price): string
+	{
+		$content = isset($this->_price_types[ $price->type() ])
+			? $this->_price_types[ $price->type() ]->name()
+			: '';
+		return $this->columnContent('type', $content);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_description(EE_Price $price): string
+	{
+		$content = stripslashes($price->desc());
+		return $this->columnContent('description', $content);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_amount(EE_Price $price): string
+	{
+		$price_type = isset($this->_price_types[ $price->type() ])
+			? $this->_price_types[ $price->type() ]
+			: null;
+		$content = $price_type instanceof EE_Price_Type && $price_type->is_percent() ?
+			'<div class="pad-amnt-rght">' . number_format($price->amount(), 1) . '%</div>'
+			: '<div class="pad-amnt-rght">' . EEH_Template::format_currency($price->amount()) . '</div>';
+		return $this->columnContent('amount', $content, 'end');
+	}
 }

caffeinated/admin/new/pricing/Price_Types_List_Table.class.php

Indentation +250 added lines, -250 removed lines

@@ -13,254 +13,254 @@
  */
 class Price_Types_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var Pricing_Admin_Page
-     */
-    protected $_admin_page;
-
-
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->_PRT = EEM_Price_Type::instance();
-    }
-
-
-    protected function _setup_data()
-    {
-        $trashed               = $this->_admin_page->get_view() == 'trashed';
-        $this->_data           = $this->_admin_page->get_price_types_overview_data($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_price_types_overview_data($this->_per_page, true);
-        $this->_trashed_count  = $this->_admin_page->get_price_types_overview_data($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = [
-            'singular' => esc_html__('price type', 'event_espresso'),
-            'plural'   => esc_html__('price types', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        ];
-
-        $this->_columns = [
-            'cb'        => '<input type="checkbox" />', // Render a checkbox instead of text
-            'id'        => esc_html__('ID', 'event_espresso'),
-            'name'      => esc_html__('Name', 'event_espresso'),
-            'base_type' => esc_html__('Base Type', 'event_espresso'),
-            'percent'   => sprintf(
-                               /* translators: 1: HTML new line, 2: open span tag, 3: close span tag */
-                esc_html__('Applied %1$s as %2$s%%%3$s or %2$s$%3$s', 'event_espresso'),
-                '',
-                '<span class="big-text">',
-                '</span>'
-            ),
-            'order'     => esc_html__('Order of Application', 'event_espresso'),
-        ];
-
-        $this->_sortable_columns = [
-            // TRUE means its already sorted
-            'name' => ['name' => false],
-        ];
-
-        $this->_hidden_columns = [];
-    }
-
-
-    protected function _get_table_filters()
-    {
-        return [];
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_default_price_types',
-                'pricing_trash_price_type'
-            )
-        ) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    /**
-     * @param EE_Price_Type $price_type
-     * @param string   $action
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    protected function getActionUrl(EE_Price_Type $price_type, string $action): string
-    {
-        if (! in_array($action, self::$actions)) {
-            throw new DomainException(esc_html__('Invalid Action', 'event_espresso'));
-        }
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'   => "{$action}_price_type",
-                'id'       => $price_type->ID(),
-                'noheader' => $action !== self::ACTION_EDIT,
-            ],
-            PRICING_ADMIN_URL
-        );
-    }
-
-
-    public function column_cb($item): string
-    {
-        if ($item->base_type() !== 1) {
-            return sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" />',
-                $item->ID()
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * @param EE_Price_Type $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_id($item): string
-    {
-        $content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">' . $this->column_name($item, false) . '</span>';
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Price_Type $price_type
-     * @param bool          $prep_content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_name(EE_Price_Type $price_type, bool $prep_content = true): string
-    {
-
-        // Build row actions
-        $actions   = [];
-        $name_link = $price_type->name();
-        // edit price link
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_default_price_type',
-                'pricing_edit_price_type',
-                $price_type->ID()
-            )
-        ) {
-            $name_link = $this->getActionLink(
-                $this->getActionUrl($price_type, self::ACTION_EDIT),
-                stripslashes($price_type->name()),
-                sprintf(
-                    /* translators: The name of the price type */
-                    esc_attr__('Edit Price Type (%s)', 'event_espresso'),
-                    $price_type->name()
-                )
-            );
-
-            $actions['edit'] = $this->getActionLink(
-                $this->getActionUrl($price_type, self::ACTION_EDIT),
-                esc_html__('Edit', 'event_espresso'),
-                sprintf(
-                    /* translators: The name of the price type */
-                    esc_attr__('Edit Price Type (%s)', 'event_espresso'),
-                    $price_type->name()
-                )
-            );
-        }
-
-        if ($price_type->base_type() !== 1) {
-            if ($this->_view == 'all') {
-                // trash price link
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price_type',
-                        'pricing_trash_price_type',
-                        $price_type->ID()
-                    )
-                ) {
-                    $actions['trash'] = $this->getActionLink(
-                        $this->getActionUrl($price_type, self::ACTION_TRASH),
-                        esc_html__('Trash', 'event_espresso'),
-                        sprintf(
-                            /* translators: The name of the price type */
-                            esc_attr__('Move Price Type %s to Trash', 'event_espresso'),
-                            $price_type->name()
-                        )
-                    );
-                }
-            } else {
-                // restore price link
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price_type',
-                        'pricing_restore_price_type',
-                        $price_type->ID()
-                    )
-                ) {
-                    $actions['restore'] = $this->getActionLink(
-                        $this->getActionUrl($price_type, self::ACTION_RESTORE),
-                        esc_html__('Restore', 'event_espresso'),
-                        sprintf(
-                            /* translators: The name of the price type */
-                            esc_attr__('Restore Price Type (%s)', 'event_espresso'),
-                            $price_type->name()
-                        )
-                    );
-                }
-                // delete price link
-                if (
-                    EE_Registry::instance()->CAP->current_user_can(
-                        'ee_delete_default_price_type',
-                        'pricing_delete_price_type',
-                        $price_type->ID()
-                    )
-                ) {
-                    $actions['delete'] = $this->getActionLink(
-                        $this->getActionUrl($price_type, self::ACTION_DELETE),
-                        esc_html__('Delete Permanently', 'event_espresso'),
-                        sprintf(
-                            /* translators: The name of the price type */
-                            esc_attr__('Delete Price Type %s Permanently', 'event_espresso'),
-                            $price_type->name()
-                        )
-                    );
-                }
-            }
-        }
-
-        $content = $prep_content ? $name_link . $this->row_actions($actions) : $name_link;
-        return $prep_content ? $this->columnContent('name', $content) : $content;
-    }
-
-
-    public function column_base_type($price_type): string
-    {
-        return $this->columnContent('base_type', $price_type->base_type_name());
-    }
-
-
-    public function column_percent($price_type): string
-    {
-        $content = $price_type->is_percent() ? '%' : EE_Registry::instance()->CFG->currency->sign;
-        return $this->columnContent('percent', $content, 'center');
-    }
-
-
-    public function column_order($price_type): string
-    {
-        return $this->columnContent('order', $price_type->order(), 'end');
-    }
+	/**
+	 * @var Pricing_Admin_Page
+	 */
+	protected $_admin_page;
+
+
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->_PRT = EEM_Price_Type::instance();
+	}
+
+
+	protected function _setup_data()
+	{
+		$trashed               = $this->_admin_page->get_view() == 'trashed';
+		$this->_data           = $this->_admin_page->get_price_types_overview_data($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_price_types_overview_data($this->_per_page, true);
+		$this->_trashed_count  = $this->_admin_page->get_price_types_overview_data($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = [
+			'singular' => esc_html__('price type', 'event_espresso'),
+			'plural'   => esc_html__('price types', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		];
+
+		$this->_columns = [
+			'cb'        => '<input type="checkbox" />', // Render a checkbox instead of text
+			'id'        => esc_html__('ID', 'event_espresso'),
+			'name'      => esc_html__('Name', 'event_espresso'),
+			'base_type' => esc_html__('Base Type', 'event_espresso'),
+			'percent'   => sprintf(
+							   /* translators: 1: HTML new line, 2: open span tag, 3: close span tag */
+				esc_html__('Applied %1$s as %2$s%%%3$s or %2$s$%3$s', 'event_espresso'),
+				'',
+				'<span class="big-text">',
+				'</span>'
+			),
+			'order'     => esc_html__('Order of Application', 'event_espresso'),
+		];
+
+		$this->_sortable_columns = [
+			// TRUE means its already sorted
+			'name' => ['name' => false],
+		];
+
+		$this->_hidden_columns = [];
+	}
+
+
+	protected function _get_table_filters()
+	{
+		return [];
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_default_price_types',
+				'pricing_trash_price_type'
+			)
+		) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	/**
+	 * @param EE_Price_Type $price_type
+	 * @param string   $action
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	protected function getActionUrl(EE_Price_Type $price_type, string $action): string
+	{
+		if (! in_array($action, self::$actions)) {
+			throw new DomainException(esc_html__('Invalid Action', 'event_espresso'));
+		}
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'   => "{$action}_price_type",
+				'id'       => $price_type->ID(),
+				'noheader' => $action !== self::ACTION_EDIT,
+			],
+			PRICING_ADMIN_URL
+		);
+	}
+
+
+	public function column_cb($item): string
+	{
+		if ($item->base_type() !== 1) {
+			return sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" />',
+				$item->ID()
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param EE_Price_Type $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_id($item): string
+	{
+		$content = '<span class="ee-entity-id">' . $item->ID() . '</span>';
+		$content .= '<span class="show-on-mobile-view-only">' . $this->column_name($item, false) . '</span>';
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Price_Type $price_type
+	 * @param bool          $prep_content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_name(EE_Price_Type $price_type, bool $prep_content = true): string
+	{
+
+		// Build row actions
+		$actions   = [];
+		$name_link = $price_type->name();
+		// edit price link
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_default_price_type',
+				'pricing_edit_price_type',
+				$price_type->ID()
+			)
+		) {
+			$name_link = $this->getActionLink(
+				$this->getActionUrl($price_type, self::ACTION_EDIT),
+				stripslashes($price_type->name()),
+				sprintf(
+					/* translators: The name of the price type */
+					esc_attr__('Edit Price Type (%s)', 'event_espresso'),
+					$price_type->name()
+				)
+			);
+
+			$actions['edit'] = $this->getActionLink(
+				$this->getActionUrl($price_type, self::ACTION_EDIT),
+				esc_html__('Edit', 'event_espresso'),
+				sprintf(
+					/* translators: The name of the price type */
+					esc_attr__('Edit Price Type (%s)', 'event_espresso'),
+					$price_type->name()
+				)
+			);
+		}
+
+		if ($price_type->base_type() !== 1) {
+			if ($this->_view == 'all') {
+				// trash price link
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price_type',
+						'pricing_trash_price_type',
+						$price_type->ID()
+					)
+				) {
+					$actions['trash'] = $this->getActionLink(
+						$this->getActionUrl($price_type, self::ACTION_TRASH),
+						esc_html__('Trash', 'event_espresso'),
+						sprintf(
+							/* translators: The name of the price type */
+							esc_attr__('Move Price Type %s to Trash', 'event_espresso'),
+							$price_type->name()
+						)
+					);
+				}
+			} else {
+				// restore price link
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price_type',
+						'pricing_restore_price_type',
+						$price_type->ID()
+					)
+				) {
+					$actions['restore'] = $this->getActionLink(
+						$this->getActionUrl($price_type, self::ACTION_RESTORE),
+						esc_html__('Restore', 'event_espresso'),
+						sprintf(
+							/* translators: The name of the price type */
+							esc_attr__('Restore Price Type (%s)', 'event_espresso'),
+							$price_type->name()
+						)
+					);
+				}
+				// delete price link
+				if (
+					EE_Registry::instance()->CAP->current_user_can(
+						'ee_delete_default_price_type',
+						'pricing_delete_price_type',
+						$price_type->ID()
+					)
+				) {
+					$actions['delete'] = $this->getActionLink(
+						$this->getActionUrl($price_type, self::ACTION_DELETE),
+						esc_html__('Delete Permanently', 'event_espresso'),
+						sprintf(
+							/* translators: The name of the price type */
+							esc_attr__('Delete Price Type %s Permanently', 'event_espresso'),
+							$price_type->name()
+						)
+					);
+				}
+			}
+		}
+
+		$content = $prep_content ? $name_link . $this->row_actions($actions) : $name_link;
+		return $prep_content ? $this->columnContent('name', $content) : $content;
+	}
+
+
+	public function column_base_type($price_type): string
+	{
+		return $this->columnContent('base_type', $price_type->base_type_name());
+	}
+
+
+	public function column_percent($price_type): string
+	{
+		$content = $price_type->is_percent() ? '%' : EE_Registry::instance()->CFG->currency->sign;
+		return $this->columnContent('percent', $content, 'center');
+	}
+
+
+	public function column_order($price_type): string
+	{
+		return $this->columnContent('order', $price_type->order(), 'end');
+	}
 }

caffeinated/admin/extend/events/Extend_Events_Admin_Page.core.php

Indentation +1279 added lines, -1279 removed lines

@@ -16,1289 +16,1289 @@
  */
 class Extend_Events_Admin_Page extends Events_Admin_Page
 {
-    /**
-     * @var EE_Admin_Config
-     */
-    protected $admin_config;
-
-
-    /**
-     * Extend_Events_Admin_Page constructor.
-     *
-     * @param bool $routing
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
-        }
-        parent::__construct($routing);
-        $this->admin_config = $this->loader->getShared('EE_Admin_Config');
-    }
-
-
-    protected function _set_page_config()
-    {
-        parent::_set_page_config();
-
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
-        // is there a evt_id in the request?
-        $EVT_ID                                          = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID                                          = $this->request->getRequestParam('post', $EVT_ID, 'int');
-        $TKT_ID                                          = $this->request->getRequestParam('TKT_ID', 0, 'int');
-        $new_page_routes                                 = [
-            'duplicate_event'          => [
-                'func'       => '_duplicate_event',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'import_page'              => [
-                'func'       => '_import_page',
-                'capability' => 'import',
-            ],
-            'import'                   => [
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ],
-            'import_events'            => [
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ],
-            'export_events'            => [
-                'func'       => '_events_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'export_categories'        => [
-                'func'       => '_categories_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'sample_export_file'       => [
-                'func'       => '_sample_export_file',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'update_template_settings' => [
-                'func'       => '_update_template_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'ticket_list_table'        => [
-                'func'       => '_tickets_overview_list_table',
-                'capability' => 'ee_read_default_tickets',
-            ],
-        ];
-        $this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
-        $this->_page_config['edit']['metaboxes'][]       = '_premium_event_editor_meta_boxes';
-        // don't load these meta boxes if using the advanced editor
-        if (
-            ! $this->admin_config->useAdvancedEditor()
-            || ! $this->feature->allowed('use_default_ticket_manager')
-        ) {
-            $this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
-            $this->_page_config['edit']['qtips'][]       = 'EE_Event_Editor_Tips';
-
-            $legacy_editor_page_routes = [
-                'trash_ticket'    => [
-                    'func'       => '_trash_or_restore_ticket',
-                    'capability' => 'ee_delete_default_ticket',
-                    'obj_id'     => $TKT_ID,
-                    'noheader'   => true,
-                    'args'       => ['trash' => true],
-                ],
-                'trash_tickets'   => [
-                    'func'       => '_trash_or_restore_ticket',
-                    'capability' => 'ee_delete_default_tickets',
-                    'noheader'   => true,
-                    'args'       => ['trash' => true],
-                ],
-                'restore_ticket'  => [
-                    'func'       => '_trash_or_restore_ticket',
-                    'capability' => 'ee_delete_default_ticket',
-                    'obj_id'     => $TKT_ID,
-                    'noheader'   => true,
-                ],
-                'restore_tickets' => [
-                    'func'       => '_trash_or_restore_ticket',
-                    'capability' => 'ee_delete_default_tickets',
-                    'noheader'   => true,
-                ],
-                'delete_ticket'   => [
-                    'func'       => '_delete_ticket',
-                    'capability' => 'ee_delete_default_ticket',
-                    'obj_id'     => $TKT_ID,
-                    'noheader'   => true,
-                ],
-                'delete_tickets'  => [
-                    'func'       => '_delete_ticket',
-                    'capability' => 'ee_delete_default_tickets',
-                    'noheader'   => true,
-                ],
-            ];
-            $new_page_routes           = array_merge($new_page_routes, $legacy_editor_page_routes);
-        }
-
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        // partial route/config override
-        $this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
-        $this->_page_config['default']['list_table']      = 'Extend_Events_Admin_List_Table';
-
-        // add default tickets tab and template settings nav tabs (note union at end)
-        $this->_page_config = [
-                                  'ticket_list_table' => [
-                                      'nav'           => [
-                                          'label' => esc_html__('Default Tickets', 'event_espresso'),
-                                          'icon'  => 'dashicons-tickets-alt',
-                                          'order' => 60,
-                                      ],
-                                      'list_table'    => 'Tickets_List_Table',
-                                      'require_nonce' => false,
-                                  ],
-                                  'template_settings' => [
-                                      'nav'           => [
-                                          'label' => esc_html__('Templates', 'event_espresso'),
-                                          'icon'  => 'dashicons-layout',
-                                          'order' => 30,
-                                      ],
-                                      'metaboxes'     => array_merge(
-                                          ['_publish_post_box'],
-                                          $this->_default_espresso_metaboxes
-                                      ),
-                                      'help_tabs'     => [
-                                          'general_settings_templates_help_tab' => [
-                                              'title'    => esc_html__('Templates', 'event_espresso'),
-                                              'filename' => 'general_settings_templates',
-                                          ],
-                                      ],
-                                      'require_nonce' => false,
-                                  ],
-                              ] + $this->_page_config;
-
-        // add filters and actions
-        // modifying _views
-        add_filter(
-            'FHEE_event_datetime_metabox_add_additional_date_time_template',
-            [$this, 'add_additional_datetime_button'],
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_clone_button_template',
-            [$this, 'add_datetime_clone_button'],
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_timezones_template',
-            [$this, 'datetime_timezones_template'],
-            10,
-            2
-        );
-        // filters for event list table
-        add_filter(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            [$this, 'extra_list_table_actions'],
-            10,
-            2
-        );
-        // legend item
-        add_filter('FHEE__Events_Admin_Page___event_legend_items__items', [$this, 'additional_legend_items']);
-        add_action('admin_init', [$this, 'admin_init']);
-        // this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        add_filter('get_sample_permalink_html', [DuplicateEventButton::class, 'addButton'], 8, 4);
-    }
-
-
-    /**
-     * admin_init
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings = array_merge(
-            EE_Registry::$i18n_js_strings,
-            [
-                'image_confirm'          => esc_html__(
-                    'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-                    'event_espresso'
-                ),
-                'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
-                'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
-                'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
-                'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
-                'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * Add per page screen options to the default ticket list table view.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_ticket_list_table()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @param string      $return    the current html
-     * @param int         $id        the post id for the page
-     * @param string|null $new_title What the title is
-     * @param string|null $new_slug  what the slug is
-     * @return string
-     * @deprecated $VID:$
-     */
-    public function extra_permalink_field_buttons(
-        string $return,
-        int $id,
-        ?string $new_title,
-        ?string $new_slug
-    ): string {
-        $return = DuplicateEventButton::addButton($return, $id, $new_title, $new_slug);
-        return TicketSelectorShortcodeButton::addButton($return, $id, $new_title, $new_slug);
-    }
-
-
-    /**
-     * Set the list table views for the default ticket list table view.
-     */
-    public function _set_list_table_views_ticket_list_table()
-    {
-        $this->_views = [
-            'all'     => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'trashed' => [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the event editor.
-     */
-    public function load_scripts_styles_edit()
-    {
-        if (! $this->admin_config->useAdvancedEditor()) {
-            wp_register_script(
-                'ee-event-editor-heartbeat',
-                EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
-                ['ee_admin_js', 'heartbeat'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ee-accounting');
-            wp_enqueue_script('ee-event-editor-heartbeat');
-        }
-        wp_enqueue_script('event_editor_js');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     * Sets the views for the default list table view.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_list_table_views_default()
-    {
-        parent::_set_list_table_views_default();
-        $new_views    = [
-            'today' => [
-                'slug'        => 'today',
-                'label'       => esc_html__('Today', 'event_espresso'),
-                'count'       => $this->total_events_today(),
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'month' => [
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => $this->total_events_this_month(),
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        $this->_views = array_merge($this->_views, $new_views);
-    }
-
-
-    /**
-     * Returns the extra action links for the default list table view.
-     *
-     * @param array    $action_links
-     * @param EE_Event $event
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_list_table_actions(array $action_links, EE_Event $event): array
-    {
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports',
-            $event->ID()
-        )
-        ) {
-            $reports_link = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'reports',
-                    'EVT_ID' => $event->ID(),
-                ],
-                REG_ADMIN_URL
-            );
-
-            $action_links[] = '
+	/**
+	 * @var EE_Admin_Config
+	 */
+	protected $admin_config;
+
+
+	/**
+	 * Extend_Events_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+			define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
+			define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
+			define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+		}
+		parent::__construct($routing);
+		$this->admin_config = $this->loader->getShared('EE_Admin_Config');
+	}
+
+
+	protected function _set_page_config()
+	{
+		parent::_set_page_config();
+
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+		// is there a evt_id in the request?
+		$EVT_ID                                          = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID                                          = $this->request->getRequestParam('post', $EVT_ID, 'int');
+		$TKT_ID                                          = $this->request->getRequestParam('TKT_ID', 0, 'int');
+		$new_page_routes                                 = [
+			'duplicate_event'          => [
+				'func'       => '_duplicate_event',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'import_page'              => [
+				'func'       => '_import_page',
+				'capability' => 'import',
+			],
+			'import'                   => [
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			],
+			'import_events'            => [
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			],
+			'export_events'            => [
+				'func'       => '_events_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'export_categories'        => [
+				'func'       => '_categories_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'sample_export_file'       => [
+				'func'       => '_sample_export_file',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'update_template_settings' => [
+				'func'       => '_update_template_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'ticket_list_table'        => [
+				'func'       => '_tickets_overview_list_table',
+				'capability' => 'ee_read_default_tickets',
+			],
+		];
+		$this->_page_config['create_new']['metaboxes'][] = '_premium_event_editor_meta_boxes';
+		$this->_page_config['edit']['metaboxes'][]       = '_premium_event_editor_meta_boxes';
+		// don't load these meta boxes if using the advanced editor
+		if (
+			! $this->admin_config->useAdvancedEditor()
+			|| ! $this->feature->allowed('use_default_ticket_manager')
+		) {
+			$this->_page_config['create_new']['qtips'][] = 'EE_Event_Editor_Tips';
+			$this->_page_config['edit']['qtips'][]       = 'EE_Event_Editor_Tips';
+
+			$legacy_editor_page_routes = [
+				'trash_ticket'    => [
+					'func'       => '_trash_or_restore_ticket',
+					'capability' => 'ee_delete_default_ticket',
+					'obj_id'     => $TKT_ID,
+					'noheader'   => true,
+					'args'       => ['trash' => true],
+				],
+				'trash_tickets'   => [
+					'func'       => '_trash_or_restore_ticket',
+					'capability' => 'ee_delete_default_tickets',
+					'noheader'   => true,
+					'args'       => ['trash' => true],
+				],
+				'restore_ticket'  => [
+					'func'       => '_trash_or_restore_ticket',
+					'capability' => 'ee_delete_default_ticket',
+					'obj_id'     => $TKT_ID,
+					'noheader'   => true,
+				],
+				'restore_tickets' => [
+					'func'       => '_trash_or_restore_ticket',
+					'capability' => 'ee_delete_default_tickets',
+					'noheader'   => true,
+				],
+				'delete_ticket'   => [
+					'func'       => '_delete_ticket',
+					'capability' => 'ee_delete_default_ticket',
+					'obj_id'     => $TKT_ID,
+					'noheader'   => true,
+				],
+				'delete_tickets'  => [
+					'func'       => '_delete_ticket',
+					'capability' => 'ee_delete_default_tickets',
+					'noheader'   => true,
+				],
+			];
+			$new_page_routes           = array_merge($new_page_routes, $legacy_editor_page_routes);
+		}
+
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		// partial route/config override
+		$this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
+		$this->_page_config['default']['list_table']      = 'Extend_Events_Admin_List_Table';
+
+		// add default tickets tab and template settings nav tabs (note union at end)
+		$this->_page_config = [
+								  'ticket_list_table' => [
+									  'nav'           => [
+										  'label' => esc_html__('Default Tickets', 'event_espresso'),
+										  'icon'  => 'dashicons-tickets-alt',
+										  'order' => 60,
+									  ],
+									  'list_table'    => 'Tickets_List_Table',
+									  'require_nonce' => false,
+								  ],
+								  'template_settings' => [
+									  'nav'           => [
+										  'label' => esc_html__('Templates', 'event_espresso'),
+										  'icon'  => 'dashicons-layout',
+										  'order' => 30,
+									  ],
+									  'metaboxes'     => array_merge(
+										  ['_publish_post_box'],
+										  $this->_default_espresso_metaboxes
+									  ),
+									  'help_tabs'     => [
+										  'general_settings_templates_help_tab' => [
+											  'title'    => esc_html__('Templates', 'event_espresso'),
+											  'filename' => 'general_settings_templates',
+										  ],
+									  ],
+									  'require_nonce' => false,
+								  ],
+							  ] + $this->_page_config;
+
+		// add filters and actions
+		// modifying _views
+		add_filter(
+			'FHEE_event_datetime_metabox_add_additional_date_time_template',
+			[$this, 'add_additional_datetime_button'],
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_clone_button_template',
+			[$this, 'add_datetime_clone_button'],
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_timezones_template',
+			[$this, 'datetime_timezones_template'],
+			10,
+			2
+		);
+		// filters for event list table
+		add_filter(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			[$this, 'extra_list_table_actions'],
+			10,
+			2
+		);
+		// legend item
+		add_filter('FHEE__Events_Admin_Page___event_legend_items__items', [$this, 'additional_legend_items']);
+		add_action('admin_init', [$this, 'admin_init']);
+		// this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		add_filter('get_sample_permalink_html', [DuplicateEventButton::class, 'addButton'], 8, 4);
+	}
+
+
+	/**
+	 * admin_init
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings = array_merge(
+			EE_Registry::$i18n_js_strings,
+			[
+				'image_confirm'          => esc_html__(
+					'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+					'event_espresso'
+				),
+				'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
+				'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
+				'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
+				'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
+				'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * Add per page screen options to the default ticket list table view.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_ticket_list_table()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @param string      $return    the current html
+	 * @param int         $id        the post id for the page
+	 * @param string|null $new_title What the title is
+	 * @param string|null $new_slug  what the slug is
+	 * @return string
+	 * @deprecated $VID:$
+	 */
+	public function extra_permalink_field_buttons(
+		string $return,
+		int $id,
+		?string $new_title,
+		?string $new_slug
+	): string {
+		$return = DuplicateEventButton::addButton($return, $id, $new_title, $new_slug);
+		return TicketSelectorShortcodeButton::addButton($return, $id, $new_title, $new_slug);
+	}
+
+
+	/**
+	 * Set the list table views for the default ticket list table view.
+	 */
+	public function _set_list_table_views_ticket_list_table()
+	{
+		$this->_views = [
+			'all'     => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'trashed' => [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the event editor.
+	 */
+	public function load_scripts_styles_edit()
+	{
+		if (! $this->admin_config->useAdvancedEditor()) {
+			wp_register_script(
+				'ee-event-editor-heartbeat',
+				EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+				['ee_admin_js', 'heartbeat'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ee-accounting');
+			wp_enqueue_script('ee-event-editor-heartbeat');
+		}
+		wp_enqueue_script('event_editor_js');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 * Sets the views for the default list table view.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_list_table_views_default()
+	{
+		parent::_set_list_table_views_default();
+		$new_views    = [
+			'today' => [
+				'slug'        => 'today',
+				'label'       => esc_html__('Today', 'event_espresso'),
+				'count'       => $this->total_events_today(),
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'month' => [
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => $this->total_events_this_month(),
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		$this->_views = array_merge($this->_views, $new_views);
+	}
+
+
+	/**
+	 * Returns the extra action links for the default list table view.
+	 *
+	 * @param array    $action_links
+	 * @param EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_list_table_actions(array $action_links, EE_Event $event): array
+	{
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports',
+			$event->ID()
+		)
+		) {
+			$reports_link = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'reports',
+					'EVT_ID' => $event->ID(),
+				],
+				REG_ADMIN_URL
+			);
+
+			$action_links[] = '
                 <a href="' . $reports_link . '"
                     aria-label="' . esc_attr__('View Report', 'event_espresso') . '"
                     class="ee-aria-tooltip button button--icon-only"
                 >
                     <span class="dashicons dashicons-chart-bar"></span>
                 </a>';
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            $action_links[] = EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                ['EVT_ID' => $event->ID()]
-            );
-        }
-        return $action_links;
-    }
-
-
-    /**
-     * @param $items
-     * @return mixed
-     */
-    public function additional_legend_items($items)
-    {
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_reports'
-        )
-        ) {
-            $items['reports'] = [
-                'class' => 'dashicons dashicons-chart-bar',
-                'desc'  => esc_html__('Event Reports', 'event_espresso'),
-            ];
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            // $related_for_icon can sometimes be a string so 'css_class' would be an illegal offset
-            // (can only use numeric offsets when treating strings as arrays)
-            if (is_array($related_for_icon) && isset($related_for_icon['css_class'], $related_for_icon['label'])) {
-                $items['view_related_messages'] = [
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                ];
-            }
-        }
-        return $items;
-    }
-
-
-    /**
-     * This is the callback method for the duplicate event route
-     * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
-     * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
-     * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
-     * After duplication the redirect is to the new event edit page.
-     *
-     * @return void
-     * @throws EE_Error If EE_Event is not available with given ID
-     * @throws ReflectionException
-     * @access protected
-     */
-    protected function _duplicate_event()
-    {
-        // first make sure the ID for the event is in the request.
-        //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        if (! $EVT_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to duplicate an event an Event ID is required.  None was given.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', [], true);
-            return;
-        }
-        // k we've got EVT_ID so let's use that to get the event we'll duplicate
-        $orig_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        if (! $orig_event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
-                    $EVT_ID
-                )
-            );
-        }
-        // k now let's clone the $orig_event before getting relations
-        $new_event = clone $orig_event;
-        // original datetimes
-        $orig_datetimes = $orig_event->get_many_related('Datetime');
-        // other original relations
-        $orig_ven = $orig_event->get_many_related('Venue');
-        // reset the ID and modify other details to make it clear this is a dupe
-        $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
-        $new_event->set('EVT_name', $new_name);
-        $new_event->set(
-            'EVT_slug',
-            wp_unique_post_slug(
-                sanitize_title($orig_event->name()),
-                0,
-                'publish',
-                'espresso_events',
-                0
-            )
-        );
-        $new_event->set('status', 'draft');
-        // duplicate discussion settings
-        $new_event->set('comment_status', $orig_event->get('comment_status'));
-        $new_event->set('ping_status', $orig_event->get('ping_status'));
-        // save the new event
-        $new_event->save();
-        // venues
-        foreach ($orig_ven as $ven) {
-            $new_event->_add_relation_to($ven, 'Venue');
-        }
-        $new_event->save();
-        // now we need to get the question group relations and handle that
-        // first primary question groups
-        $orig_primary_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_primary' => true]]
-        );
-        if (! empty($orig_primary_qgs)) {
-            foreach ($orig_primary_qgs as $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_primary' => true]);
-                }
-            }
-        }
-        // next additional attendee question groups
-        $orig_additional_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_additional' => true]]
-        );
-        if (! empty($orig_additional_qgs)) {
-            foreach ($orig_additional_qgs as $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_additional' => true]);
-                }
-            }
-        }
-
-        $new_event->save();
-
-        // k now that we have the new event saved we can loop through the datetimes and start adding relations.
-        $cloned_tickets = [];
-        foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
-                continue;
-            }
-            $new_dtt      = clone $orig_dtt;
-            $orig_tickets = $orig_dtt->tickets();
-            // save new dtt then add to event
-            $new_dtt->set('DTT_ID', 0);
-            $new_dtt->set('DTT_sold', 0);
-            $new_dtt->set_reserved(0);
-            $new_dtt->save();
-            $new_event->_add_relation_to($new_dtt, 'Datetime');
-            $new_event->save();
-            // now let's get the ticket relations setup.
-            foreach ((array) $orig_tickets as $orig_ticket) {
-                // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                // is this ticket archived?  If it is then let's skip
-                if ($orig_ticket->get('TKT_deleted')) {
-                    continue;
-                }
-                // does this original ticket already exist in the clone_tickets cache?
-                //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_ticket->ID() ])) {
-                    $new_ticket = $cloned_tickets[ $orig_ticket->ID() ];
-                } else {
-                    $new_ticket = clone $orig_ticket;
-                    // get relations on the $orig_ticket that we need to setup.
-                    $orig_prices = $orig_ticket->prices();
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    $new_ticket->set('TKT_reserved', 0);
-                    $new_ticket->save(); // make sure new ticket has ID.
-                    // price relations on new ticket need to be setup.
-                    foreach ($orig_prices as $orig_price) {
-                        $new_price = clone $orig_price;
-                        $new_price->set('PRC_ID', 0);
-                        $new_price->save();
-                        $new_ticket->_add_relation_to($new_price, 'Price');
-                        $new_ticket->save();
-                    }
-
-                    do_action(
-                        'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
-                        $orig_ticket,
-                        $new_ticket,
-                        $orig_prices,
-                        $orig_event,
-                        $orig_dtt,
-                        $new_dtt
-                    );
-                }
-                // k now we can add the new ticket as a relation to the new datetime
-                // and make sure its added to our cached $cloned_tickets array
-                // for use with later datetimes that have the same ticket.
-                $new_dtt->_add_relation_to($new_ticket, 'Ticket');
-                $new_dtt->save();
-                $cloned_tickets[ $orig_ticket->ID() ] = $new_ticket;
-            }
-        }
-        // clone taxonomy information
-        $taxonomies_to_clone_with = apply_filters(
-            'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
-            ['espresso_event_categories', 'espresso_event_type', 'post_tag']
-        );
-        // get terms for original event (notice)
-        $orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
-        // loop through terms and add them to new event.
-        foreach ($orig_terms as $term) {
-            wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
-        }
-
-        // duplicate other core WP_Post items for this event.
-        // post thumbnail (feature image).
-        $feature_image_id = get_post_thumbnail_id($orig_event->ID());
-        if ($feature_image_id) {
-            update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
-        }
-
-        // duplicate page_template setting
-        $page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
-        if ($page_template) {
-            update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
-        }
-
-        do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
-        // now let's redirect to the edit page for this duplicated event if we have a new event id.
-        if ($new_event->ID()) {
-            $redirect_args = [
-                'post'   => $new_event->ID(),
-                'action' => 'edit',
-            ];
-            EE_Error::add_success(
-                esc_html__(
-                    'Event successfully duplicated.  Please review the details below and make any necessary edits',
-                    'event_espresso'
-                )
-            );
-        } else {
-            $redirect_args = [
-                'action' => 'default',
-            ];
-            EE_Error::add_error(
-                esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $redirect_args, true);
-    }
-
-
-    /**
-     * Generates output for the import page.
-     *
-     * @throws EE_Error
-     */
-    protected function _import_page()
-    {
-        $title = esc_html__('Import', 'event_espresso');
-        $intro = esc_html__(
-            'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
-            'event_espresso'
-        );
-
-        $form_url = EVENTS_ADMIN_URL;
-        $action   = 'import_events';
-        $type     = 'csv';
-
-        $this->_template_args['form'] = EE_Import::instance()->upload_form(
-            $title,
-            $intro,
-            $form_url,
-            $action,
-            $type
-        );
-
-        $this->_template_args['sample_file_link']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'sample_export_file'],
-            $this->_admin_base_url
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _import_events
-     * This handles displaying the screen and running imports for importing events.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _import_events()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        $success = EE_Import::instance()->import();
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Import File', 'event_espresso'),
-            'ran',
-            ['action' => 'import_page'],
-            true
-        );
-    }
-
-
-    /**
-     * _events_export
-     * Will export all (or just the given event) to a Excel compatible file.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _events_export()
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('EVT_IDs', $EVT_ID, 'int');
-        $this->request->mergeRequestParams(
-            [
-                'export' => 'report',
-                'action' => 'all_event_data',
-                'EVT_ID' => $EVT_ID,
-            ]
-        );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $this->request->mergeRequestParams(
-            [
-                'export' => 'report',
-                'action' => 'categories',
-                'EVT_ID' => $EVT_ID,
-            ]
-        );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * Creates a sample CSV file for importing
-     */
-    protected function _sample_export_file()
-    {
-        $EE_Export = EE_Export::instance();
-        if ($EE_Export instanceof EE_Export) {
-            $EE_Export->export();
-        }
-    }
-
-
-    /*************        Template Settings        *************/
-    /**
-     * Generates template settings page output
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _template_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        $this->_template_args = apply_filters(
-            'FHEE__General_Settings_Admin_Page__template_settings__template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_template_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating template settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_template_settings()
-    {
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        EE_Registry::instance()->CFG->template_settings = apply_filters(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            EE_Registry::instance()->CFG->template_settings,
-            $this->request->requestParams()
-        );
-        // update custom post type slugs and detect if we need to flush rewrite rules
-        $old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
-
-        $event_cpt_slug = $this->request->getRequestParam('event_cpt_slug');
-
-        EE_Registry::instance()->CFG->core->event_cpt_slug = $event_cpt_slug
-            ? EEH_URL::slugify($event_cpt_slug, 'events')
-            : EE_Registry::instance()->CFG->core->event_cpt_slug;
-
-        $what    = esc_html__('Template Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->template_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        if (EE_Registry::instance()->CFG->core->event_cpt_slug !== $old_slug) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-        }
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'template_settings']);
-    }
-
-
-    /**
-     * _premium_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _premium_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (
-            ! $this->admin_config->useAdvancedEditor()
-            || ! $this->feature->allowed('use_reg_options_meta_box')
-        ) {
-            $this->addMetaBox(
-                'espresso_event_editor_event_options',
-                esc_html__('Event Registration Options', 'event_espresso'),
-                [$this, 'registration_options_meta_box'],
-                $this->page_slug,
-                'side',
-                'core'
-            );
-        }
-    }
-
-
-    /**
-     * override caf metabox
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-
-        $template_args['active_status']    = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['_event']           = $this->_cpt_model_obj;
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
-            'EVT_default_registration_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * wp_list_table_mods for caf
-     * ============================
-     */
-
-
-    /**
-     * espresso_event_months_dropdown
-     *
-     * @deprecatd $VID:$
-     * @access public
-     * @return string                dropdown listing month/year selections for events.
-     * @throws EE_Error
-     */
-    public function espresso_event_months_dropdown(): string
-    {
-        // what we need to do is get all PRIMARY datetimes for all events to filter on.
-        // Note we need to include any other filters that are set!
-        return EEH_Form_Fields::generate_event_months_dropdown(
-            $this->request->getRequestParam('month_range'),
-            $this->request->getRequestParam('status'),
-            $this->request->getRequestParam('EVT_CAT', 0, 'int'),
-            $this->request->getRequestParam('active_status')
-        );
-    }
-
-
-    /**
-     * returns a list of "active" statuses on the event
-     *
-     * @deprecatd $VID:$
-     * @param string $current_value whatever the current active status is
-     * @return string
-     */
-    public function active_status_dropdown(string $current_value = ''): string
-    {
-        $select_name = 'active_status';
-        $values      = [
-            'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
-            'active'   => esc_html__('Active', 'event_espresso'),
-            'upcoming' => esc_html__('Upcoming', 'event_espresso'),
-            'expired'  => esc_html__('Expired', 'event_espresso'),
-            'inactive' => esc_html__('Inactive', 'event_espresso'),
-        ];
-
-        return EEH_Form_Fields::select_input($select_name, $values, $current_value);
-    }
-
-
-    /**
-     * returns a list of "venues"
-     *
-     * @deprecatd $VID:$
-     * @param string $current_value whatever the current active status is
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function venuesDropdown(string $current_value = ''): string
-    {
-        $values = ['' => esc_html__('All Venues', 'event_espresso')];
-        // populate the list of venues.
-        $venues = EEM_Venue::instance()->get_all(['order_by' => ['VNU_name' => 'ASC']]);
-
-        foreach ($venues as $venue) {
-            $values[ $venue->ID() ] = $venue->name();
-        }
-
-        return EEH_Form_Fields::select_input('venue', $values, $current_value);
-    }
-
-
-    /**
-     * output a dropdown of the categories for the category filter on the event admin list table
-     *
-     * @deprecatd $VID:$
-     * @access  public
-     * @return string html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function category_dropdown(): string
-    {
-        return EEH_Form_Fields::generate_event_category_dropdown(
-            $this->request->getRequestParam('EVT_CAT', -1, 'int')
-        );
-    }
-
-
-    /**
-     * get total number of events today
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_events_today(): int
-    {
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end   = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = [
-            'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
-        ];
-        return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-    }
-
-
-    /**
-     * get total number of events this month
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_events_this_month(): int
-    {
-        // Dates
-        $this_year_r     = date('Y');
-        $this_month_r    = date('m');
-        $days_this_month = date('t');
-        $start           = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end             = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where           = [
-            'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
-        ];
-        return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-    }
-
-
-    /** DEFAULT TICKETS STUFF **/
-
-    /**
-     * Output default tickets list table view.
-     *
-     * @throws EE_Error
-     */
-    public function _tickets_overview_list_table()
-    {
-        if (
-            $this->admin_config->useAdvancedEditor()
-            && $this->feature->allowed('use_default_ticket_manager')
-        ) {
-            // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                EVENTS_CAF_TEMPLATE_PATH . 'default_tickets_moved_notice.template.php',
-                [],
-                true
-            );
-            $this->display_admin_page_with_no_sidebar();
-        } else {
-            $this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
-            $this->display_admin_list_table_page_with_no_sidebar();
-        }
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $trashed
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_default_tickets(int $per_page = 10, bool $count = false, bool $trashed = false)
-    {
-        $orderby = $this->request->getRequestParam('orderby', 'TKT_name');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-        switch ($orderby) {
-            case 'TKT_name':
-                $orderby = ['TKT_name' => $order];
-                break;
-            case 'TKT_price':
-                $orderby = ['TKT_price' => $order];
-                break;
-            case 'TKT_uses':
-                $orderby = ['TKT_uses' => $order];
-                break;
-            case 'TKT_min':
-                $orderby = ['TKT_min' => $order];
-                break;
-            case 'TKT_max':
-                $orderby = ['TKT_max' => $order];
-                break;
-            case 'TKT_qty':
-                $orderby = ['TKT_qty' => $order];
-                break;
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-        $offset       = ($current_page - 1) * $per_page;
-
-        $where = [
-            'TKT_is_default' => 1,
-            'TKT_deleted'    => $trashed,
-        ];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'TKT_name'        => ['LIKE', $search_term],
-                'TKT_description' => ['LIKE', $search_term],
-            ];
-        }
-
-        return $count
-            ? EEM_Ticket::instance()->count_deleted_and_undeleted([$where])
-            : EEM_Ticket::instance()->get_all_deleted_and_undeleted(
-                [
-                    $where,
-                    'order_by' => $orderby,
-                    'limit'    => [$offset, $per_page],
-                    'group_by' => 'TKT_ID',
-                ]
-            );
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_ticket(bool $trash = false)
-    {
-        $success = 1;
-        $TKT     = EEM_Ticket::instance();
-        // checkboxes?
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            foreach ($checkboxes as $TKT_ID => $value) {
-                if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                } elseif (! $TKT->restore_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
-            if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            } elseif (! $TKT->restore_by_ID($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = $trash ? 'moved to the trash' : 'restored';
-        $query_args  = [
-            'action' => 'ticket_list_table',
-            'status' => $trash ? '' : 'trashed',
-        ];
-        $this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
-    }
-
-
-    /**
-     * Handles trashing default ticket.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_ticket()
-    {
-        $success = 1;
-        // checkboxes?
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            foreach ($checkboxes as $TKT_ID => $value) {
-                // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
-            if (! $this->_delete_the_ticket($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = 'deleted';
-        $query_args  = [
-            'action' => 'ticket_list_table',
-            'status' => 'trashed',
-        ];
-        // fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
-        if (
-        EEM_Ticket::instance()->count_deleted_and_undeleted(
-            [['TKT_is_default' => 1]],
-            'TKT_ID',
-            true
-        )
-        ) {
-            $query_args = [];
-        }
-        $this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param int $TKT_ID
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_the_ticket(int $TKT_ID)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
-        if (! $ticket instanceof EE_Ticket) {
-            return false;
-        }
-        $ticket->_remove_relations('Datetime');
-        // delete all related prices first
-        $ticket->delete_related_permanently('Price');
-        return $ticket->delete_permanently();
-    }
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			$action_links[] = EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				['EVT_ID' => $event->ID()]
+			);
+		}
+		return $action_links;
+	}
+
+
+	/**
+	 * @param $items
+	 * @return mixed
+	 */
+	public function additional_legend_items($items)
+	{
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_reports'
+		)
+		) {
+			$items['reports'] = [
+				'class' => 'dashicons dashicons-chart-bar',
+				'desc'  => esc_html__('Event Reports', 'event_espresso'),
+			];
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			// $related_for_icon can sometimes be a string so 'css_class' would be an illegal offset
+			// (can only use numeric offsets when treating strings as arrays)
+			if (is_array($related_for_icon) && isset($related_for_icon['css_class'], $related_for_icon['label'])) {
+				$items['view_related_messages'] = [
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				];
+			}
+		}
+		return $items;
+	}
+
+
+	/**
+	 * This is the callback method for the duplicate event route
+	 * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
+	 * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
+	 * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
+	 * After duplication the redirect is to the new event edit page.
+	 *
+	 * @return void
+	 * @throws EE_Error If EE_Event is not available with given ID
+	 * @throws ReflectionException
+	 * @access protected
+	 */
+	protected function _duplicate_event()
+	{
+		// first make sure the ID for the event is in the request.
+		//  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		if (! $EVT_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to duplicate an event an Event ID is required.  None was given.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', [], true);
+			return;
+		}
+		// k we've got EVT_ID so let's use that to get the event we'll duplicate
+		$orig_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		if (! $orig_event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
+					$EVT_ID
+				)
+			);
+		}
+		// k now let's clone the $orig_event before getting relations
+		$new_event = clone $orig_event;
+		// original datetimes
+		$orig_datetimes = $orig_event->get_many_related('Datetime');
+		// other original relations
+		$orig_ven = $orig_event->get_many_related('Venue');
+		// reset the ID and modify other details to make it clear this is a dupe
+		$new_event->set('EVT_ID', 0);
+		$new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+		$new_event->set('EVT_name', $new_name);
+		$new_event->set(
+			'EVT_slug',
+			wp_unique_post_slug(
+				sanitize_title($orig_event->name()),
+				0,
+				'publish',
+				'espresso_events',
+				0
+			)
+		);
+		$new_event->set('status', 'draft');
+		// duplicate discussion settings
+		$new_event->set('comment_status', $orig_event->get('comment_status'));
+		$new_event->set('ping_status', $orig_event->get('ping_status'));
+		// save the new event
+		$new_event->save();
+		// venues
+		foreach ($orig_ven as $ven) {
+			$new_event->_add_relation_to($ven, 'Venue');
+		}
+		$new_event->save();
+		// now we need to get the question group relations and handle that
+		// first primary question groups
+		$orig_primary_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_primary' => true]]
+		);
+		if (! empty($orig_primary_qgs)) {
+			foreach ($orig_primary_qgs as $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', ['EQG_primary' => true]);
+				}
+			}
+		}
+		// next additional attendee question groups
+		$orig_additional_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_additional' => true]]
+		);
+		if (! empty($orig_additional_qgs)) {
+			foreach ($orig_additional_qgs as $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', ['EQG_additional' => true]);
+				}
+			}
+		}
+
+		$new_event->save();
+
+		// k now that we have the new event saved we can loop through the datetimes and start adding relations.
+		$cloned_tickets = [];
+		foreach ($orig_datetimes as $orig_dtt) {
+			if (! $orig_dtt instanceof EE_Datetime) {
+				continue;
+			}
+			$new_dtt      = clone $orig_dtt;
+			$orig_tickets = $orig_dtt->tickets();
+			// save new dtt then add to event
+			$new_dtt->set('DTT_ID', 0);
+			$new_dtt->set('DTT_sold', 0);
+			$new_dtt->set_reserved(0);
+			$new_dtt->save();
+			$new_event->_add_relation_to($new_dtt, 'Datetime');
+			$new_event->save();
+			// now let's get the ticket relations setup.
+			foreach ((array) $orig_tickets as $orig_ticket) {
+				// it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
+				if (! $orig_ticket instanceof EE_Ticket) {
+					continue;
+				}
+				// is this ticket archived?  If it is then let's skip
+				if ($orig_ticket->get('TKT_deleted')) {
+					continue;
+				}
+				// does this original ticket already exist in the clone_tickets cache?
+				//  If so we'll just use the new ticket from it.
+				if (isset($cloned_tickets[ $orig_ticket->ID() ])) {
+					$new_ticket = $cloned_tickets[ $orig_ticket->ID() ];
+				} else {
+					$new_ticket = clone $orig_ticket;
+					// get relations on the $orig_ticket that we need to setup.
+					$orig_prices = $orig_ticket->prices();
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_sold', 0);
+					$new_ticket->set('TKT_reserved', 0);
+					$new_ticket->save(); // make sure new ticket has ID.
+					// price relations on new ticket need to be setup.
+					foreach ($orig_prices as $orig_price) {
+						$new_price = clone $orig_price;
+						$new_price->set('PRC_ID', 0);
+						$new_price->save();
+						$new_ticket->_add_relation_to($new_price, 'Price');
+						$new_ticket->save();
+					}
+
+					do_action(
+						'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
+						$orig_ticket,
+						$new_ticket,
+						$orig_prices,
+						$orig_event,
+						$orig_dtt,
+						$new_dtt
+					);
+				}
+				// k now we can add the new ticket as a relation to the new datetime
+				// and make sure its added to our cached $cloned_tickets array
+				// for use with later datetimes that have the same ticket.
+				$new_dtt->_add_relation_to($new_ticket, 'Ticket');
+				$new_dtt->save();
+				$cloned_tickets[ $orig_ticket->ID() ] = $new_ticket;
+			}
+		}
+		// clone taxonomy information
+		$taxonomies_to_clone_with = apply_filters(
+			'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
+			['espresso_event_categories', 'espresso_event_type', 'post_tag']
+		);
+		// get terms for original event (notice)
+		$orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
+		// loop through terms and add them to new event.
+		foreach ($orig_terms as $term) {
+			wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
+		}
+
+		// duplicate other core WP_Post items for this event.
+		// post thumbnail (feature image).
+		$feature_image_id = get_post_thumbnail_id($orig_event->ID());
+		if ($feature_image_id) {
+			update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
+		}
+
+		// duplicate page_template setting
+		$page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
+		if ($page_template) {
+			update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
+		}
+
+		do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
+		// now let's redirect to the edit page for this duplicated event if we have a new event id.
+		if ($new_event->ID()) {
+			$redirect_args = [
+				'post'   => $new_event->ID(),
+				'action' => 'edit',
+			];
+			EE_Error::add_success(
+				esc_html__(
+					'Event successfully duplicated.  Please review the details below and make any necessary edits',
+					'event_espresso'
+				)
+			);
+		} else {
+			$redirect_args = [
+				'action' => 'default',
+			];
+			EE_Error::add_error(
+				esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $redirect_args, true);
+	}
+
+
+	/**
+	 * Generates output for the import page.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _import_page()
+	{
+		$title = esc_html__('Import', 'event_espresso');
+		$intro = esc_html__(
+			'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
+			'event_espresso'
+		);
+
+		$form_url = EVENTS_ADMIN_URL;
+		$action   = 'import_events';
+		$type     = 'csv';
+
+		$this->_template_args['form'] = EE_Import::instance()->upload_form(
+			$title,
+			$intro,
+			$form_url,
+			$action,
+			$type
+		);
+
+		$this->_template_args['sample_file_link']   = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'sample_export_file'],
+			$this->_admin_base_url
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _import_events
+	 * This handles displaying the screen and running imports for importing events.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _import_events()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		$success = EE_Import::instance()->import();
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Import File', 'event_espresso'),
+			'ran',
+			['action' => 'import_page'],
+			true
+		);
+	}
+
+
+	/**
+	 * _events_export
+	 * Will export all (or just the given event) to a Excel compatible file.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _events_export()
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('EVT_IDs', $EVT_ID, 'int');
+		$this->request->mergeRequestParams(
+			[
+				'export' => 'report',
+				'action' => 'all_event_data',
+				'EVT_ID' => $EVT_ID,
+			]
+		);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$this->request->mergeRequestParams(
+			[
+				'export' => 'report',
+				'action' => 'categories',
+				'EVT_ID' => $EVT_ID,
+			]
+		);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * Creates a sample CSV file for importing
+	 */
+	protected function _sample_export_file()
+	{
+		$EE_Export = EE_Export::instance();
+		if ($EE_Export instanceof EE_Export) {
+			$EE_Export->export();
+		}
+	}
+
+
+	/*************        Template Settings        *************/
+	/**
+	 * Generates template settings page output
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _template_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		$this->_template_args = apply_filters(
+			'FHEE__General_Settings_Admin_Page__template_settings__template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_template_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating template settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_template_settings()
+	{
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		EE_Registry::instance()->CFG->template_settings = apply_filters(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			EE_Registry::instance()->CFG->template_settings,
+			$this->request->requestParams()
+		);
+		// update custom post type slugs and detect if we need to flush rewrite rules
+		$old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
+
+		$event_cpt_slug = $this->request->getRequestParam('event_cpt_slug');
+
+		EE_Registry::instance()->CFG->core->event_cpt_slug = $event_cpt_slug
+			? EEH_URL::slugify($event_cpt_slug, 'events')
+			: EE_Registry::instance()->CFG->core->event_cpt_slug;
+
+		$what    = esc_html__('Template Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->template_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		if (EE_Registry::instance()->CFG->core->event_cpt_slug !== $old_slug) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+		}
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'template_settings']);
+	}
+
+
+	/**
+	 * _premium_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _premium_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+		if (
+			! $this->admin_config->useAdvancedEditor()
+			|| ! $this->feature->allowed('use_reg_options_meta_box')
+		) {
+			$this->addMetaBox(
+				'espresso_event_editor_event_options',
+				esc_html__('Event Registration Options', 'event_espresso'),
+				[$this, 'registration_options_meta_box'],
+				$this->page_slug,
+				'side',
+				'core'
+			);
+		}
+	}
+
+
+	/**
+	 * override caf metabox
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+
+		$template_args['active_status']    = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['_event']           = $this->_cpt_model_obj;
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
+			'EVT_default_registration_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * wp_list_table_mods for caf
+	 * ============================
+	 */
+
+
+	/**
+	 * espresso_event_months_dropdown
+	 *
+	 * @deprecatd $VID:$
+	 * @access public
+	 * @return string                dropdown listing month/year selections for events.
+	 * @throws EE_Error
+	 */
+	public function espresso_event_months_dropdown(): string
+	{
+		// what we need to do is get all PRIMARY datetimes for all events to filter on.
+		// Note we need to include any other filters that are set!
+		return EEH_Form_Fields::generate_event_months_dropdown(
+			$this->request->getRequestParam('month_range'),
+			$this->request->getRequestParam('status'),
+			$this->request->getRequestParam('EVT_CAT', 0, 'int'),
+			$this->request->getRequestParam('active_status')
+		);
+	}
+
+
+	/**
+	 * returns a list of "active" statuses on the event
+	 *
+	 * @deprecatd $VID:$
+	 * @param string $current_value whatever the current active status is
+	 * @return string
+	 */
+	public function active_status_dropdown(string $current_value = ''): string
+	{
+		$select_name = 'active_status';
+		$values      = [
+			'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
+			'active'   => esc_html__('Active', 'event_espresso'),
+			'upcoming' => esc_html__('Upcoming', 'event_espresso'),
+			'expired'  => esc_html__('Expired', 'event_espresso'),
+			'inactive' => esc_html__('Inactive', 'event_espresso'),
+		];
+
+		return EEH_Form_Fields::select_input($select_name, $values, $current_value);
+	}
+
+
+	/**
+	 * returns a list of "venues"
+	 *
+	 * @deprecatd $VID:$
+	 * @param string $current_value whatever the current active status is
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function venuesDropdown(string $current_value = ''): string
+	{
+		$values = ['' => esc_html__('All Venues', 'event_espresso')];
+		// populate the list of venues.
+		$venues = EEM_Venue::instance()->get_all(['order_by' => ['VNU_name' => 'ASC']]);
+
+		foreach ($venues as $venue) {
+			$values[ $venue->ID() ] = $venue->name();
+		}
+
+		return EEH_Form_Fields::select_input('venue', $values, $current_value);
+	}
+
+
+	/**
+	 * output a dropdown of the categories for the category filter on the event admin list table
+	 *
+	 * @deprecatd $VID:$
+	 * @access  public
+	 * @return string html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function category_dropdown(): string
+	{
+		return EEH_Form_Fields::generate_event_category_dropdown(
+			$this->request->getRequestParam('EVT_CAT', -1, 'int')
+		);
+	}
+
+
+	/**
+	 * get total number of events today
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_events_today(): int
+	{
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end   = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = [
+			'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
+		];
+		return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+	}
+
+
+	/**
+	 * get total number of events this month
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_events_this_month(): int
+	{
+		// Dates
+		$this_year_r     = date('Y');
+		$this_month_r    = date('m');
+		$days_this_month = date('t');
+		$start           = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-01 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end             = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where           = [
+			'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
+		];
+		return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+	}
+
+
+	/** DEFAULT TICKETS STUFF **/
+
+	/**
+	 * Output default tickets list table view.
+	 *
+	 * @throws EE_Error
+	 */
+	public function _tickets_overview_list_table()
+	{
+		if (
+			$this->admin_config->useAdvancedEditor()
+			&& $this->feature->allowed('use_default_ticket_manager')
+		) {
+			// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				EVENTS_CAF_TEMPLATE_PATH . 'default_tickets_moved_notice.template.php',
+				[],
+				true
+			);
+			$this->display_admin_page_with_no_sidebar();
+		} else {
+			$this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
+			$this->display_admin_list_table_page_with_no_sidebar();
+		}
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $trashed
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_default_tickets(int $per_page = 10, bool $count = false, bool $trashed = false)
+	{
+		$orderby = $this->request->getRequestParam('orderby', 'TKT_name');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+		switch ($orderby) {
+			case 'TKT_name':
+				$orderby = ['TKT_name' => $order];
+				break;
+			case 'TKT_price':
+				$orderby = ['TKT_price' => $order];
+				break;
+			case 'TKT_uses':
+				$orderby = ['TKT_uses' => $order];
+				break;
+			case 'TKT_min':
+				$orderby = ['TKT_min' => $order];
+				break;
+			case 'TKT_max':
+				$orderby = ['TKT_max' => $order];
+				break;
+			case 'TKT_qty':
+				$orderby = ['TKT_qty' => $order];
+				break;
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+		$offset       = ($current_page - 1) * $per_page;
+
+		$where = [
+			'TKT_is_default' => 1,
+			'TKT_deleted'    => $trashed,
+		];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'TKT_name'        => ['LIKE', $search_term],
+				'TKT_description' => ['LIKE', $search_term],
+			];
+		}
+
+		return $count
+			? EEM_Ticket::instance()->count_deleted_and_undeleted([$where])
+			: EEM_Ticket::instance()->get_all_deleted_and_undeleted(
+				[
+					$where,
+					'order_by' => $orderby,
+					'limit'    => [$offset, $per_page],
+					'group_by' => 'TKT_ID',
+				]
+			);
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_ticket(bool $trash = false)
+	{
+		$success = 1;
+		$TKT     = EEM_Ticket::instance();
+		// checkboxes?
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			foreach ($checkboxes as $TKT_ID => $value) {
+				if ($trash) {
+					if (! $TKT->delete_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				} elseif (! $TKT->restore_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
+			if ($trash) {
+				if (! $TKT->delete_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			} elseif (! $TKT->restore_by_ID($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = $trash ? 'moved to the trash' : 'restored';
+		$query_args  = [
+			'action' => 'ticket_list_table',
+			'status' => $trash ? '' : 'trashed',
+		];
+		$this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
+	}
+
+
+	/**
+	 * Handles trashing default ticket.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_ticket()
+	{
+		$success = 1;
+		// checkboxes?
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			foreach ($checkboxes as $TKT_ID => $value) {
+				// delete
+				if (! $this->_delete_the_ticket($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
+			if (! $this->_delete_the_ticket($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = 'deleted';
+		$query_args  = [
+			'action' => 'ticket_list_table',
+			'status' => 'trashed',
+		];
+		// fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
+		if (
+		EEM_Ticket::instance()->count_deleted_and_undeleted(
+			[['TKT_is_default' => 1]],
+			'TKT_ID',
+			true
+		)
+		) {
+			$query_args = [];
+		}
+		$this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param int $TKT_ID
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_the_ticket(int $TKT_ID)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
+		if (! $ticket instanceof EE_Ticket) {
+			return false;
+		}
+		$ticket->_remove_relations('Datetime');
+		// delete all related prices first
+		$ticket->delete_related_permanently('Price');
+		return $ticket->delete_permanently();
+	}
 }