eventespresso / event-espresso-core

core/db_classes/EE_Event.class.php

Spacing +10 added lines, -10 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function getAvailableSpacesCalculator()
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -213,7 +213,7 @@ 
      */
     public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
     {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -236,7 +236,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return array();
         }
         $datetime_ids = array();
@@ -429,7 +429,7 @@ 
     public function short_description($num_words = 55, $more = null, $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -883,7 +883,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -972,7 +972,7 @@ 
      */
     public function is_sold_out($actual = false)
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1017,11 +1017,11 @@ 
     public function get_active_status($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) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = array(array('EVT_ID' => $this->ID()));
@@ -1106,7 +1106,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();
@@ -1290,7 +1290,7 @@ 
             ]
         );
         $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = 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');

Indentation +1437 added lines, -1437 removed lines

@@ -15,1441 +15,1441 @@
 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
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $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
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        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
-     */
-    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
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_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, $new_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, $new_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', $new_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', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        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
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('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 boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        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
-     */
-    public function first_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
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        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 $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('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 untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $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  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $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 bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        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
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // 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.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // 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
-     */
-    public function is_active()
-    {
-        // 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
-     */
-    public function is_expired()
-    {
-        // 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
-     */
-    public function is_inactive()
-    {
-        // 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 $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $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 events'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
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all tickets
-        $tickets = $this->tickets(
-            array(
-                'default_where_conditions' => 'none',
-                'order_by' => array('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_Event::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.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    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 qtys 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 float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($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
-     */
-    public function is_sold_out($actual = false)
-    {
-        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()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        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
-     */
-    public function get_active_status($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 = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::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 datetime's
-                        // 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
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    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
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        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
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('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
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('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
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        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
-     */
-    public function get_permalink()
-    {
-        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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($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_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
-     */
-    public function get_all_event_categories($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, $for_primary = false)
-    {
-        // 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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, $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
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                '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()
-    {
-        $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
-     */
-    public function setRegistrationFormUuid(string $UUID): void
-    {
-        $this->set('FSC_UUID', $UUID);
-    }
+	/**
+	 * 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
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $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
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		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
+	 */
+	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
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_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, $new_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, $new_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', $new_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', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		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
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('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 boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		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
+	 */
+	public function first_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
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		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 $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('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 untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$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  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$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 bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		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
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// 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.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// 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
+	 */
+	public function is_active()
+	{
+		// 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
+	 */
+	public function is_expired()
+	{
+		// 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
+	 */
+	public function is_inactive()
+	{
+		// 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 $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $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 events'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
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all tickets
+		$tickets = $this->tickets(
+			array(
+				'default_where_conditions' => 'none',
+				'order_by' => array('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_Event::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.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	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 qtys 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 float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($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
+	 */
+	public function is_sold_out($actual = false)
+	{
+		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()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		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
+	 */
+	public function get_active_status($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 = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::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 datetime's
+						// 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
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	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
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		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
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('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
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('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
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		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
+	 */
+	public function get_permalink()
+	{
+		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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($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_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
+	 */
+	public function get_all_event_categories($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, $for_primary = false)
+	{
+		// 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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, $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
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'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()
+	{
+		$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
+	 */
+	public function setRegistrationFormUuid(string $UUID): void
+	{
+		$this->set('FSC_UUID', $UUID);
+	}
 }

admin_pages/events/Events_Admin_Page.core.php

Indentation +2860 added lines, -2860 removed lines

@@ -20,2864 +20,2864 @@
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * This will hold the event object for event_details screen.
-     *
-     * @access protected
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug = EVENTS_PG_SLUG;
-        $this->page_label = EVENTS_LABEL;
-        $this->_admin_base_url = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_events' => 'edit',
-        ];
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', [$this, 'save_timezonestring_setting']);
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-        // is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        $this->_page_routes = [
-            'default'                       => [
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ],
-            'create_new'                    => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ],
-            'edit'                          => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-            ],
-            'copy_event'                    => [
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ],
-            'trash_event'                   => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ],
-            'trash_events'                  => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'restore_event'                 => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ],
-            'restore_events'                => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'delete_event'                  => [
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ],
-            'delete_events'                 => [
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'view_report'                   => [
-                'func'       => '_view_report',
-                'capability' => 'ee_edit_events',
-            ],
-            'default_event_settings'        => [
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_default_event_settings' => [
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'template_settings'             => [
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ],
-            // event category tab related
-            'add_category'                  => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['add'],
-            ],
-            'edit_category'                 => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['edit'],
-            ],
-            'delete_categories'             => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'delete_category'               => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'insert_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'update_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'category_list'                 => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ],
-            'preview_deletion' => [
-                'func' => 'previewDeletion',
-                'capability' => 'ee_delete_events',
-            ],
-            'confirm_deletion' => [
-                'func' => 'confirmDeletion',
-                'capability' => 'ee_delete_events',
-                'noheader' => true,
-            ]
-        ];
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default'                => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_overview_help_tab'                       => [
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ],
-                    'events_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ],
-                    'events_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ],
-                    'events_overview_view_help_tab'                  => [
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ],
-                    'events_overview_other_help_tab'                 => [
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => [
-                //     'Event_Overview_Help_Tour',
-                //     // 'New_Features_Test_Help_Tour' for testing multiple help tour
-                // ],
-                'qtips'         => [
-                    'EE_Event_List_Table_Tips',
-                ],
-                'require_nonce' => false,
-                'qtips'         => ['EE_Event_List_Table_Tips'],
-            ],
-            'create_new'             => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => [
-                //     'Event_Editor_Help_Tour',
-                // ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'edit'                   => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['post'])
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            ['post' => $this->_req_data['post'], 'action' => 'edit'],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default_event_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ],
-                'help_tabs'     => [
-                    'default_settings_help_tab'        => [
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ],
-                    'default_settings_status_help_tab' => [
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ],
-                    'default_maximum_tickets_help_tab' => [
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => ['Event_Default_Settings_Help_Tour'],
-                'require_nonce' => false,
-            ],
-            // template settings
-            'template_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'general_settings_templates_help_tab' => [
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => ['Templates_Help_Tour'],
-                'require_nonce' => false,
-            ],
-            // event category stuff
-            'add_category'           => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => ['Event_Add_Category_Help_Tour'],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'edit_category'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['EVT_CAT_ID'])
-                        ? add_query_arg(
-                            ['EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ],
-                ],
-                /*'help_tour' => ['Event_Edit_Category_Help_Tour'],*/
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'category_list'          => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_categories_help_tab'                       => [
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ],
-                    'events_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ],
-                    'events_categories_view_help_tab'                  => [
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ],
-                    'events_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => [
-                //     'Event_Categories_Help_Tour',
-                // ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'preview_deletion'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Preview Deletion', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-        // only load EE_Event_Editor_Decaf_Tips if domain is not caffeinated
-        $domain = $this->loader->getShared('EventEspresso\core\domain\Domain');
-        if (! $domain->isCaffeinated()) {
-            $this->_page_config['create_new']['qtips'] = ['EE_Event_Editor_Decaf_Tips'];
-            $this->_page_config['edit']['qtips'] = ['EE_Event_Editor_Decaf_Tips'];
-        }
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'ee-cat-admin',
-            EVENTS_ASSETS_URL . 'ee-cat-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        // scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // scripts
-        if (! $this->admin_config->useAdvancedEditor()) {
-            wp_register_script(
-                'event-datetime-metabox',
-                EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-                ['event_editor_js', 'ee-datepicker'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_script('event-datetime-metabox');
-        }
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        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'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
-     * group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param EE_Event $event Event object
-     * @param string   $req_type
-     * @return void
-     * @throws EE_Error
-     * @access public
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if (! empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (! $event instanceof EE_Event) {
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        // made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        }
-        if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
-            return;
-        }
-        // made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            sprintf(
-                esc_html__(
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
-                    'event_espresso'
-                ),
-                '<a class="espresso-help-tab-lnk">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button-secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'draft' => [
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     *
-     * @return array
-     */
-    protected function _event_legend_items()
-    {
-        $items = [
-            'view_details'   => [
-                'class' => 'dashicons dashicons-search',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ],
-            'edit_event'     => [
-                'class' => 'ee-icon ee-icon-calendar-edit',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ],
-            'view_attendees' => [
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ],
-        ];
-        $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = [
-            'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ],
-            'active_status'    => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ],
-            'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ],
-            'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ],
-            'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ],
-            'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ],
-        ];
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _event_model()
-    {
-        if (! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string $return    the current html
-     * @param int    $id        the post id for the page
-     * @param string $new_title What the title is
-     * @param string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _events_overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array) $this->_template_args['after_list_table']
-            : [];
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
-                                                                              . EEH_Template::get_button_or_link(
-                                                                                  get_post_type_archive_link('espresso_events'),
-                                                                                  esc_html__('View Event Archive Page', 'event_espresso'),
-                                                                                  'button'
-                                                                              );
-        $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
-     * other meta saves. So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param object $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            // get out we're not processing an event save.
-            return;
-        }
-        $event_values = [
-            'EVT_member_only'     => ! empty($this->_req_data['member_only']) ? 1 : 0,
-            'EVT_allow_overflow'  => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
-            'EVT_timezone_string' => ! empty($this->_req_data['timezone_string'])
-                ? sanitize_text_field($this->_req_data['timezone_string'])
-                : null,
-        ];
-        /** @var FeatureFlags $flags */
-        $flags = $this->loader->getShared('EventEspresso\core\domain\services\capabilities\FeatureFlags');
-        // check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
-        if (! $this->admin_config->useAdvancedEditor() || ! $flags->featureAllowed('use_reg_options_meta_box')) {
-            $event_values['EVT_display_ticket_selector'] =
-                ! empty($this->_req_data['display_ticket_selector'])
-                    ? 1
-                    : 0;
-            $event_values['EVT_additional_limit'] = min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                ! empty($this->_req_data['additional_limit'])
-                    ? absint($this->_req_data['additional_limit'])
-                    : null
-            );
-            $event_values['EVT_default_registration_status'] =
-                ! empty($this->_req_data['EVT_default_registration_status'])
-                    ? sanitize_text_field($this->_req_data['EVT_default_registration_status'])
-                    : EE_Registry::instance()->CFG->registration->default_STS_ID;
-            $event_values['EVT_external_URL'] = ! empty($this->_req_data['externalURL'])
-                ? esc_url_raw($this->_req_data['externalURL'])
-                : null;
-            $event_values['EVT_phone'] = ! empty($this->_req_data['event_phone'])
-                ? sanitize_text_field($this->_req_data['event_phone'])
-                : null;
-        }
-        // update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        // get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = [
-            $this->_event_model()->primary_key_name() => $post_id,
-            'OR'                                      => [
-                'status'   => $post->post_status,
-                // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                // but the returned object here has a status of "publish", so use the original post status as well
-                'status*1' => $this->_req_data['original_post_status'],
-            ],
-        ];
-        $event = $this->_event_model()->get_one([$get_one_where]);
-        // the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            [
-                [$this, '_default_venue_update'],
-                [$this, '_default_tickets_update'],
-            ]
-        );
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? $e_callback($event, $this->_req_data)
-                : false;
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = ! $att_success ? $att_success : $_success;
-        }
-        // any errors?
-        if ($success && false === $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @param int $revision_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @see parent::restore_item()
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        // copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            // meta revision restore
-            $post_evt->restore_revision($revision_id);
-            // related objs restore
-            $post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
-        }
-    }
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param EE_Event $evtobj Event Object to add the venue to
-     * @param array    $data   The request data from the form
-     * @return bool           Success or fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _default_venue_update(EE_Event $evtobj, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $rows_affected = null;
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = [
-            'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        ];
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
-            $update_where = [$venue_model->primary_key_name() => $venue_id];
-            $rows_affected = $venue_model->update($venue_array, [$update_where]);
-            // we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0;
-        }
-        // we insert the venue
-        $venue_id = $venue_model->insert($venue_array);
-        $evtobj->_add_relation_to($venue_id, 'Venue');
-        return ! empty($venue_id) ? true : false;
-        // when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param EE_Event $evtobj The Event object we're attaching data to
-     * @param array    $data   The request data from the form
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _default_tickets_update(EE_Event $evtobj, $data)
-    {
-        if ($this->admin_config->useAdvancedEditor()) {
-            return [];
-        }
-        $success = true;
-        $saved_dtt = null;
-        $saved_tickets = [];
-        $incoming_date_formats = ['Y-m-d', 'h:i a'];
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
-            // trim all values to ensure any excess whitespace is removed.
-            $dtt = array_map('trim', $dtt);
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
-                : $dtt['DTT_EVT_start'];
-            $datetime_values = [
-                'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
-                'DTT_EVT_start' => $dtt['DTT_EVT_start'],
-                'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            ];
-            // if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
-            if (! empty($dtt['DTT_ID'])) {
-                $DTM = EE_Registry::instance()
-                                  ->load_model('Datetime', [$evtobj->get_timezone()])
-                                  ->get_one_by_ID($dtt['DTT_ID']);
-                $DTM->set_date_format($incoming_date_formats[0]);
-                $DTM->set_time_format($incoming_date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-                // make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
-                $saved_dtts[ $DTM->ID() ] = $DTM;
-            } else {
-                $DTM = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    [$datetime_values, $evtobj->get_timezone(), $incoming_date_formats],
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-            }
-            $DTM->save();
-            $DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
-            // load DTT helper
-            // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
-                $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
-                $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
-                $DTT->save();
-            }
-            // now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
-            $saved_dtt = $DTT;
-            $success = ! $success ? $success : $DTT;
-            // if ANY of these updates fail then we want the appropriate global error message.
-            // //todo this is actually sucky we need a better error message but this is what it is for now.
-        }
-        // no dtts get deleted so we don't do any of that logic here.
-        // update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $incoming_date_formats = ['Y-m-d', 'h:i a'];
-            $update_prices = false;
-            $ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
-                ? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map('trim', $tkt);
-            if (empty($tkt['TKT_start_date'])) {
-                // let's use now in the set timezone.
-                $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                // use the start date of the first datetime
-                $dtt = $evtobj->first_datetime();
-                $tkt['TKT_end_date'] = $dtt->start_date_and_time(
-                    $incoming_date_formats[0],
-                    $incoming_date_formats[1]
-                );
-            }
-            $TKT_values = [
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-            ];
-            // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID'] = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $TKT_values['TKT_price'] = $ticket_price;
-                $update_prices = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
-            // keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (! empty($tkt['TKT_ID'])) {
-                $TKT = EE_Registry::instance()
-                                  ->load_model('Ticket', [$evtobj->get_timezone()])
-                                  ->get_one_by_ID($tkt['TKT_ID']);
-                if ($TKT instanceof EE_Ticket) {
-                    $ticket_sold = $TKT->count_related(
-                        'Registration',
-                        [
-                                [
-                                    'STS_ID' => [
-                                        'NOT IN',
-                                        [EEM_Registration::status_id_incomplete],
-                                    ],
-                                ],
-                            ]
-                    ) > 0;
-                    // let's just check the total price for the existing ticket and determine if it matches the new
-                    // total price.  if they are different then we create a new ticket (if tickets sold)
-                    // if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $ticket_sold && ! $TKT->deleted()
-                                      && EEH_Money::compare_floats(
-                                          $ticket_price,
-                                          $TKT->get('TKT_price'),
-                                          '!=='
-                                      );
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    // set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field === 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    // if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        // archive the old ticket first
-                        $TKT->set('TKT_deleted', 1);
-                        $TKT->save();
-                        // make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
-                        $saved_tickets[ $TKT->ID() ] = $TKT;
-                        // create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
-                        $TKT = clone $TKT;
-                        $TKT->set('TKT_ID', 0);
-                        $TKT->set('TKT_deleted', 0);
-                        $TKT->set('TKT_price', $ticket_price);
-                        $TKT->set('TKT_sold', 0);
-                        // now we need to make sure that $new prices are created as well and attached to new ticket.
-                        $update_prices = true;
-                    }
-                    // make sure price is set if it hasn't been already
-                    $TKT->set('TKT_price', $ticket_price);
-                }
-            } else {
-                // no TKT_id so a new TKT
-                $TKT_values['TKT_price'] = $ticket_price;
-                $TKT = EE_Registry::instance()->load_class('Ticket', [$TKT_values], false, false);
-                if ($TKT instanceof EE_Ticket) {
-                    // need to reset values to properly account for the date formats
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    $TKT->set_timezone($evtobj->get_timezone());
-                    // set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field === 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    $update_prices = true;
-                }
-            }
-            // cap ticket qty by datetime reg limits
-            $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
-            // update ticket.
-            $TKT->save();
-            // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
-                $TKT->save();
-            }
-            // initially let's add the ticket to the dtt
-            $saved_dtt->_add_relation_to($TKT, 'Ticket');
-            $saved_tickets[ $TKT->ID() ] = $TKT;
-            // add prices to ticket
-            $this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices);
-        }
-        // however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            // get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            // need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($dtts as $dtt) {
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            // finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return [$saved_dtt, $saved_tickets];
-    }
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices     Array of prices from the form.
-     * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
-     * @return  void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
-    {
-        foreach ($prices as $row => $prc) {
-            $PRC_values = [
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            ];
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $PRC = EE_Registry::instance()->load_class('Price', [$PRC_values], false, false);
-            } else {
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                // update this price with new values
-                foreach ($PRC_values as $field => $newprc) {
-                    $PRC->set($field, $newprc);
-                }
-                $PRC->save();
-            }
-            $ticket->_add_relation_to($PRC, 'Price');
-        }
-    }
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-    }
-
-
-    /**
-     *    _generate_publish_box_extra_content
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        // load formatter helper
-        // args for getting related registrations
-        $approved_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ],
-        ];
-        $not_approved_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ],
-        ];
-        $pending_payment_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ],
-        ];
-        // publish box
-        $publish_box_extra_args = [
-            'view_approved_reg_url'        => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ],
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        ];
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        $use_advanced_editor = $this->admin_config->useAdvancedEditor();
-        /** @var FeatureFlags $flags */
-        $flags = $this->loader->getShared('EventEspresso\core\domain\services\capabilities\FeatureFlags');
-        // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (! $use_advanced_editor || ! $flags->featureAllowed('use_reg_options_meta_box')) {
-            add_meta_box(
-                'espresso_event_editor_event_options',
-                esc_html__('Event Registration Options', 'event_espresso'),
-                [$this, 'registration_options_meta_box'],
-                $this->page_slug,
-                'side'
-            );
-        }
-        if (! $use_advanced_editor) {
-            add_meta_box(
-                'espresso_event_editor_tickets',
-                esc_html__('Event Datetime & Ticket', 'event_espresso'),
-                [$this, 'ticket_metabox'],
-                $this->page_slug,
-                'normal',
-                'high'
-            );
-        } else {
-            if ($flags->featureAllowed('use_reg_options_meta_box')) {
-                add_action(
-                    'add_meta_boxes_espresso_events',
-                    function () {
-                        global $current_screen;
-                        remove_meta_box('authordiv', $current_screen, 'normal');
-                    },
-                    99
-                );
-            }
-        }
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = [];
-        // defaults for template args
-        $template_args = [
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'ee-lock-icon',
-            'disabled'                 => '',
-        ];
-        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        // do we get related tickets?
-        if (
-            $first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time'] = $first_datetime;
-            $related_tickets = $first_datetime->tickets(
-                [
-                    ['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
-                    'default_where_conditions' => 'none',
-                ]
-            );
-            if (! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket $ticket */
-            $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure'] = $this->_get_ticket_row(
-            EE_Registry::instance()->load_model('Ticket')->create_default_object(),
-            true
-        );
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param EE_Ticket $ticket   the ticket object
-     * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int       $row
-     * @return string generated html for the ticket row.
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        ];
-        $price = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
-            : EE_Registry::instance()->load_model('Price')->create_default_object();
-        $price_args = [
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        ];
-        // make sure we have default start and end dates if skeleton
-        // handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            // if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            // get the earliest datetime (if present);
-            $earliest_dtt = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    ['order_by' => ['DTT_EVT_start' => 'ASC']]
-                )
-                : null;
-            if (! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
-            } else {
-                $template_args['TKT_end_date'] = date(
-                    'Y-m-d h:i a',
-                    mktime(0, 0, 0, date('m'), date('d') + 7, date('Y'))
-                );
-            }
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    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,
-            ],
-            true
-        );
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $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['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_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array an array of event objects.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEME = $this->_event_model();
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        if (isset($this->_req_data['month_range'])) {
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
-            // simulate the FIRST day of the month, that fixes issues for months like February
-            // where PHP doesn't know what to assume for date.
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where = [];
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        // determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                break;
-            case 'draft':
-                $where['status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['status'] = $status;
-        }
-        // categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT'] : null;
-        if (! empty($category)) {
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
-            $where['Term_Taxonomy.term_id'] = $category;
-        }
-        // date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] !== '') {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone('UTC')
-            );
-            $start = $DateTime->getTimestamp();
-            // set the datetime to be the end of the month
-            $DateTime->setDate(
-                $year_r,
-                $month_r,
-                $DateTime->format('t')
-            )->setTime(23, 59, 59);
-            $end = $DateTime->getTimestamp();
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] === 'today') {
-            $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] === 'month') {
-            $now = date('Y-m-01');
-            $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                            ->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } elseif (
-            ! isset($where['status'])
-                  && ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')
-        ) {
-            $where['OR'] = [
-                'status*restrict_private' => ['!=', 'private'],
-                'AND'                     => [
-                    'status*inclusive' => ['=', 'private'],
-                    'EVT_wp_user'      => get_current_user_id(),
-                ],
-            ];
-        }
-
-        if (
-            isset($this->_req_data['EVT_wp_user'])
-            && (int) $this->_req_data['EVT_wp_user'] !== (int) get_current_user_id()
-            && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-        ) {
-            $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
-        }
-        // search query handling
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = [
-                'EVT_name'       => ['LIKE', $search_string],
-                'EVT_desc'       => ['LIKE', $search_string],
-                'EVT_short_desc' => ['LIKE', $search_string],
-            ];
-        }
-        // filter events by venue.
-        if (isset($this->_req_data['venue']) && ! empty($this->_req_data['venue'])) {
-            $where['Venue.VNU_ID'] = absint($this->_req_data['venue']);
-        }
-        $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
-        $query_params = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            [
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ],
-            $this->_req_data
-        );
-
-        // let's first check if we have special requests coming in.
-        if (isset($this->_req_data['active_status'])) {
-            switch ($this->_req_data['active_status']) {
-                case 'upcoming':
-                    return $EEME->get_upcoming_events($query_params, $count);
-                    break;
-                case 'expired':
-                    return $EEME->get_expired_events($query_params, $count);
-                    break;
-                case 'active':
-                    return $EEME->get_active_events($query_params, $count);
-                    break;
-                case 'inactive':
-                    return $EEME->get_inactive_events($query_params, $count);
-                    break;
-            }
-        }
-
-        $events = $count ? $EEME->count([$where], 'EVT_ID', true) : $EEME->get_all($query_params);
-        return $events;
-    }
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_cpt_item($post_id)
-    {
-        throw new EE_Error(esc_html__('Please contact Event Espresso support with the details of the steps taken to produce this error.', 'event_espresso'));
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_delete_event();
-    }
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param string $event_status
-     * @param bool   $redirect_after
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        // determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if (! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param string $event_status
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (! empty($event_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : [];
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access  private
-     * @param int    $EVT_ID
-     * @param string $event_status
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if (! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook = 'AHEE_event_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * _delete_event
-     *
-     * @access protected
-     * @param bool $redirect_after
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_event()
-    {
-        $this->generateDeletionPreview(isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : []);
-    }
-
-    /**
-     * Gets the tree traversal batch persister.
-     * @since 4.10.12.p
-     * @return NodeGroupDao
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getModelObjNodeGroupPersister()
-    {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
-            $this->model_obj_node_group_persister = $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
-        }
-        return $this->model_obj_node_group_persister;
-    }
-
-    /**
-     * _delete_events
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_events()
-    {
-        $this->generateDeletionPreview(isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : []);
-    }
-
-    protected function generateDeletionPreview($event_ids)
-    {
-        $event_ids = (array) $event_ids;
-        // Set a code we can use to reference this deletion task in the batch jobs and preview page.
-        $deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
-        $return_url = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'preview_deletion',
-                'deletion_job_code' => $deletion_job_code,
-            ],
-            $this->_admin_base_url
-        );
-        $event_ids = array_map(
-            'intval',
-            $event_ids
-        );
-
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'              => 'espresso_batch',
-                    'batch'             => EED_Batch::batch_job,
-                    'EVT_IDs'           => $event_ids,
-                    'deletion_job_code' => $deletion_job_code,
-                    'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
-                    'return_url'        => urlencode($return_url),
-                ],
-                admin_url()
-            )
-        );
-    }
-
-    /**
-     * Checks for a POST submission
-     * @since 4.10.12.p
-     */
-    protected function confirmDeletion()
-    {
-        $deletion_redirect_logic = $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
-        $deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
-    }
-
-    /**
-     * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
-     * @since 4.10.12.p
-     * @throws EE_Error
-     */
-    protected function previewDeletion()
-    {
-        $preview_deletion_logic = $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
-        $this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function total_events()
-    {
-        $count = EEM_Event::instance()->count(['caps' => 'read_admin'], 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function total_events_draft()
-    {
-        $where = [
-            'status' => ['IN', ['draft', 'auto-draft']],
-        ];
-        $count = EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function total_trashed_events()
-    {
-        $where = [
-            'status' => 'trash',
-        ];
-        $count = EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        // exclude
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'update_default_event_settings',
-                'html_id'         => 'update_default_event_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    [
-                        'default_reg_status'  => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            [
-                                'default'         => isset($registration_config->default_STS_ID)
-                                                     && array_key_exists(
-                                                         $registration_config->default_STS_ID,
-                                                         $registration_stati_for_selection
-                                                     )
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
-                                    : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_settings_status_help_tab'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            [
-                                'default'         => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                )
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_maximum_tickets_help_tab"'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_default_event_settings()
-    {
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $registration_config = EE_Registry::instance()->CFG->registration;
-                $valid_data = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                do_action(
-                    'AHEE__Events_Admin_Page___update_default_event_settings',
-                    $valid_data,
-                    EE_Registry::instance()->CFG,
-                    $this
-                );
-                // update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    __('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
-    }
-
-
-    /*************        Templates        *************/
-    protected function _template_settings()
-    {
-        $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img'] = '<img src="'
-                                               . EVENTS_ASSETS_URL
-                                               . '/images/'
-                                               . 'caffeinated_template_features.jpg" alt="'
-                                               . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                               . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        // set default category object
-        $this->_set_empty_category_object();
-        // only set if we've got an id
-        if (! isset($this->_req_data['EVT_CAT_ID'])) {
-            return;
-        }
-        $category_id = absint($this->_req_data['EVT_CAT_ID']);
-        $term = get_term($category_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
-            $this->_category->category_name = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc = $term->description;
-            $this->_category->id = $term->term_id;
-            $this->_category->parent = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details view.
-     *
-     * @param string $view
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-        $route = $view === 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        // custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'category_list'],
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details content.
-     *
-     * @throws DomainException
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms = get_terms(
-            [EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     */
-    protected function _delete_categories()
-    {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
-            : (array) $this->_req_data['category_id'];
-        foreach ($cat_ids as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    /**
-     * Handles deleting specific category.
-     *
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-    }
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     *
-     * @param bool $new_category true means we're triggering the insert of a new category.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Inserts or updates category
-     *
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-        // was the category_identifier input disabled?
-        if (isset($this->_req_data['category_identifier'])) {
-            $term_args['slug'] = $this->_req_data['category_identifier'];
-        }
-        $insert_ids = $update
-            ? wp_update_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
-            : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-        if (! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $cat_id = $insert_ids['term_id'];
-            $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-        return $cat_id;
-    }
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     *
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $limit = ($current_page - 1) * $per_page;
-        $where = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $sstr],
-                'description' => ['LIKE', $sstr],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-        $categories = $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-        return $categories;
-    }
-
-    /* end category stuff */
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function save_timezonestring_setting()
-    {
-        $timezone_string = isset($this->_req_data['timezone_selected'])
-            ? $this->_req_data['timezone_selected']
-            : '';
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
-            EE_Error::add_error(
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, ['action' => 'create_new']);
-    }
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @access protected
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug = EVENTS_PG_SLUG;
+		$this->page_label = EVENTS_LABEL;
+		$this->_admin_base_url = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_events' => 'edit',
+		];
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', [$this, 'save_timezonestring_setting']);
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+		// is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		$this->_page_routes = [
+			'default'                       => [
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			],
+			'create_new'                    => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			],
+			'edit'                          => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+			],
+			'copy_event'                    => [
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			],
+			'trash_event'                   => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			],
+			'trash_events'                  => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'restore_event'                 => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			],
+			'restore_events'                => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'delete_event'                  => [
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			],
+			'delete_events'                 => [
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'view_report'                   => [
+				'func'       => '_view_report',
+				'capability' => 'ee_edit_events',
+			],
+			'default_event_settings'        => [
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			],
+			'update_default_event_settings' => [
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'template_settings'             => [
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			],
+			// event category tab related
+			'add_category'                  => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['add'],
+			],
+			'edit_category'                 => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['edit'],
+			],
+			'delete_categories'             => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'delete_category'               => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'insert_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'update_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'category_list'                 => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			],
+			'preview_deletion' => [
+				'func' => 'previewDeletion',
+				'capability' => 'ee_delete_events',
+			],
+			'confirm_deletion' => [
+				'func' => 'confirmDeletion',
+				'capability' => 'ee_delete_events',
+				'noheader' => true,
+			]
+		];
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default'                => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => [
+					'events_overview_help_tab'                       => [
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					],
+					'events_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					],
+					'events_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					],
+					'events_overview_view_help_tab'                  => [
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					],
+					'events_overview_other_help_tab'                 => [
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => [
+				//     'Event_Overview_Help_Tour',
+				//     // 'New_Features_Test_Help_Tour' for testing multiple help tour
+				// ],
+				'qtips'         => [
+					'EE_Event_List_Table_Tips',
+				],
+				'require_nonce' => false,
+				'qtips'         => ['EE_Event_List_Table_Tips'],
+			],
+			'create_new'             => [
+				'nav'           => [
+					'label'      => esc_html__('Add Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => [
+				//     'Event_Editor_Help_Tour',
+				// ],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'edit'                   => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['post'])
+						? EE_Admin_Page::add_query_args_and_nonce(
+							['post' => $this->_req_data['post'], 'action' => 'edit'],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default_event_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'labels'        => [
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				],
+				'help_tabs'     => [
+					'default_settings_help_tab'        => [
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					],
+					'default_settings_status_help_tab' => [
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					],
+					'default_maximum_tickets_help_tab' => [
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => ['Event_Default_Settings_Help_Tour'],
+				'require_nonce' => false,
+			],
+			// template settings
+			'template_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'general_settings_templates_help_tab' => [
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => ['Templates_Help_Tour'],
+				'require_nonce' => false,
+			],
+			// event category stuff
+			'add_category'           => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_category_help_tab' => [
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => ['Event_Add_Category_Help_Tour'],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'edit_category'          => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['EVT_CAT_ID'])
+						? add_query_arg(
+							['EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					],
+				],
+				/*'help_tour' => ['Event_Edit_Category_Help_Tour'],*/
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'category_list'          => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				],
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'events_categories_help_tab'                       => [
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					],
+					'events_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					],
+					'events_categories_view_help_tab'                  => [
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					],
+					'events_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => [
+				//     'Event_Categories_Help_Tour',
+				// ],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'preview_deletion'       => [
+				'nav'           => [
+					'label'      => esc_html__('Preview Deletion', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'require_nonce' => false,
+			],
+		];
+		// only load EE_Event_Editor_Decaf_Tips if domain is not caffeinated
+		$domain = $this->loader->getShared('EventEspresso\core\domain\Domain');
+		if (! $domain->isCaffeinated()) {
+			$this->_page_config['create_new']['qtips'] = ['EE_Event_Editor_Decaf_Tips'];
+			$this->_page_config['edit']['qtips'] = ['EE_Event_Editor_Decaf_Tips'];
+		}
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'ee-cat-admin',
+			EVENTS_ASSETS_URL . 'ee-cat-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		// scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// scripts
+		if (! $this->admin_config->useAdvancedEditor()) {
+			wp_register_script(
+				'event-datetime-metabox',
+				EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+				['event_editor_js', 'ee-datepicker'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_script('event-datetime-metabox');
+		}
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		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'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
+	 * group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param EE_Event $event Event object
+	 * @param string   $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if (! empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (! $event instanceof EE_Event) {
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		// made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		}
+		if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if (! $event->tickets_on_sale()) {
+			return;
+		}
+		// made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			sprintf(
+				esc_html__(
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
+					'event_espresso'
+				),
+				'<a class="espresso-help-tab-lnk">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button-secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'draft' => [
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 *
+	 * @return array
+	 */
+	protected function _event_legend_items()
+	{
+		$items = [
+			'view_details'   => [
+				'class' => 'dashicons dashicons-search',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			],
+			'edit_event'     => [
+				'class' => 'ee-icon ee-icon-calendar-edit',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			],
+			'view_attendees' => [
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			],
+		];
+		$items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = [
+			'sold_out_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			],
+			'active_status'    => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			],
+			'upcoming_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			],
+			'postponed_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			],
+			'expired_status'   => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			],
+			'inactive_status'  => [
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			],
+		];
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _event_model()
+	{
+		if (! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string $return    the current html
+	 * @param int    $id        the post id for the page
+	 * @param string $new_title What the title is
+	 * @param string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _events_overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
+			? (array) $this->_template_args['after_list_table']
+			: [];
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
+																			  . EEH_Template::get_button_or_link(
+																				  get_post_type_archive_link('espresso_events'),
+																				  esc_html__('View Event Archive Page', 'event_espresso'),
+																				  'button'
+																			  );
+		$this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
+	 * other meta saves. So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param object $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			// get out we're not processing an event save.
+			return;
+		}
+		$event_values = [
+			'EVT_member_only'     => ! empty($this->_req_data['member_only']) ? 1 : 0,
+			'EVT_allow_overflow'  => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
+			'EVT_timezone_string' => ! empty($this->_req_data['timezone_string'])
+				? sanitize_text_field($this->_req_data['timezone_string'])
+				: null,
+		];
+		/** @var FeatureFlags $flags */
+		$flags = $this->loader->getShared('EventEspresso\core\domain\services\capabilities\FeatureFlags');
+		// check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
+		if (! $this->admin_config->useAdvancedEditor() || ! $flags->featureAllowed('use_reg_options_meta_box')) {
+			$event_values['EVT_display_ticket_selector'] =
+				! empty($this->_req_data['display_ticket_selector'])
+					? 1
+					: 0;
+			$event_values['EVT_additional_limit'] = min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				! empty($this->_req_data['additional_limit'])
+					? absint($this->_req_data['additional_limit'])
+					: null
+			);
+			$event_values['EVT_default_registration_status'] =
+				! empty($this->_req_data['EVT_default_registration_status'])
+					? sanitize_text_field($this->_req_data['EVT_default_registration_status'])
+					: EE_Registry::instance()->CFG->registration->default_STS_ID;
+			$event_values['EVT_external_URL'] = ! empty($this->_req_data['externalURL'])
+				? esc_url_raw($this->_req_data['externalURL'])
+				: null;
+			$event_values['EVT_phone'] = ! empty($this->_req_data['event_phone'])
+				? sanitize_text_field($this->_req_data['event_phone'])
+				: null;
+		}
+		// update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		// get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = [
+			$this->_event_model()->primary_key_name() => $post_id,
+			'OR'                                      => [
+				'status'   => $post->post_status,
+				// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+				// but the returned object here has a status of "publish", so use the original post status as well
+				'status*1' => $this->_req_data['original_post_status'],
+			],
+		];
+		$event = $this->_event_model()->get_one([$get_one_where]);
+		// the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			[
+				[$this, '_default_venue_update'],
+				[$this, '_default_tickets_update'],
+			]
+		);
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? $e_callback($event, $this->_req_data)
+				: false;
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = ! $att_success ? $att_success : $_success;
+		}
+		// any errors?
+		if ($success && false === $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @param int $revision_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @see parent::restore_item()
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		// copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			// meta revision restore
+			$post_evt->restore_revision($revision_id);
+			// related objs restore
+			$post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
+		}
+	}
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param EE_Event $evtobj Event Object to add the venue to
+	 * @param array    $data   The request data from the form
+	 * @return bool           Success or fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _default_venue_update(EE_Event $evtobj, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$rows_affected = null;
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = [
+			'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		];
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if (! empty($venue_id)) {
+			$update_where = [$venue_model->primary_key_name() => $venue_id];
+			$rows_affected = $venue_model->update($venue_array, [$update_where]);
+			// we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0;
+		}
+		// we insert the venue
+		$venue_id = $venue_model->insert($venue_array);
+		$evtobj->_add_relation_to($venue_id, 'Venue');
+		return ! empty($venue_id) ? true : false;
+		// when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param EE_Event $evtobj The Event object we're attaching data to
+	 * @param array    $data   The request data from the form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _default_tickets_update(EE_Event $evtobj, $data)
+	{
+		if ($this->admin_config->useAdvancedEditor()) {
+			return [];
+		}
+		$success = true;
+		$saved_dtt = null;
+		$saved_tickets = [];
+		$incoming_date_formats = ['Y-m-d', 'h:i a'];
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
+			// trim all values to ensure any excess whitespace is removed.
+			$dtt = array_map('trim', $dtt);
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
+				: $dtt['DTT_EVT_start'];
+			$datetime_values = [
+				'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
+				'DTT_EVT_start' => $dtt['DTT_EVT_start'],
+				'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			];
+			// if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
+			if (! empty($dtt['DTT_ID'])) {
+				$DTM = EE_Registry::instance()
+								  ->load_model('Datetime', [$evtobj->get_timezone()])
+								  ->get_one_by_ID($dtt['DTT_ID']);
+				$DTM->set_date_format($incoming_date_formats[0]);
+				$DTM->set_time_format($incoming_date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+				// make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
+				$saved_dtts[ $DTM->ID() ] = $DTM;
+			} else {
+				$DTM = EE_Registry::instance()->load_class(
+					'Datetime',
+					[$datetime_values, $evtobj->get_timezone(), $incoming_date_formats],
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+			}
+			$DTM->save();
+			$DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
+			// load DTT helper
+			// before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
+				$DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
+				$DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
+				$DTT->save();
+			}
+			// now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
+			$saved_dtt = $DTT;
+			$success = ! $success ? $success : $DTT;
+			// if ANY of these updates fail then we want the appropriate global error message.
+			// //todo this is actually sucky we need a better error message but this is what it is for now.
+		}
+		// no dtts get deleted so we don't do any of that logic here.
+		// update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$incoming_date_formats = ['Y-m-d', 'h:i a'];
+			$update_prices = false;
+			$ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
+				? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map('trim', $tkt);
+			if (empty($tkt['TKT_start_date'])) {
+				// let's use now in the set timezone.
+				$now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				// use the start date of the first datetime
+				$dtt = $evtobj->first_datetime();
+				$tkt['TKT_end_date'] = $dtt->start_date_and_time(
+					$incoming_date_formats[0],
+					$incoming_date_formats[1]
+				);
+			}
+			$TKT_values = [
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+			];
+			// if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID'] = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$TKT_values['TKT_price'] = $ticket_price;
+				$update_prices = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
+			// keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (! empty($tkt['TKT_ID'])) {
+				$TKT = EE_Registry::instance()
+								  ->load_model('Ticket', [$evtobj->get_timezone()])
+								  ->get_one_by_ID($tkt['TKT_ID']);
+				if ($TKT instanceof EE_Ticket) {
+					$ticket_sold = $TKT->count_related(
+						'Registration',
+						[
+								[
+									'STS_ID' => [
+										'NOT IN',
+										[EEM_Registration::status_id_incomplete],
+									],
+								],
+							]
+					) > 0;
+					// let's just check the total price for the existing ticket and determine if it matches the new
+					// total price.  if they are different then we create a new ticket (if tickets sold)
+					// if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $ticket_sold && ! $TKT->deleted()
+									  && EEH_Money::compare_floats(
+										  $ticket_price,
+										  $TKT->get('TKT_price'),
+										  '!=='
+									  );
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					// set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field === 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					// if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						// archive the old ticket first
+						$TKT->set('TKT_deleted', 1);
+						$TKT->save();
+						// make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
+						$saved_tickets[ $TKT->ID() ] = $TKT;
+						// create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
+						$TKT = clone $TKT;
+						$TKT->set('TKT_ID', 0);
+						$TKT->set('TKT_deleted', 0);
+						$TKT->set('TKT_price', $ticket_price);
+						$TKT->set('TKT_sold', 0);
+						// now we need to make sure that $new prices are created as well and attached to new ticket.
+						$update_prices = true;
+					}
+					// make sure price is set if it hasn't been already
+					$TKT->set('TKT_price', $ticket_price);
+				}
+			} else {
+				// no TKT_id so a new TKT
+				$TKT_values['TKT_price'] = $ticket_price;
+				$TKT = EE_Registry::instance()->load_class('Ticket', [$TKT_values], false, false);
+				if ($TKT instanceof EE_Ticket) {
+					// need to reset values to properly account for the date formats
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					$TKT->set_timezone($evtobj->get_timezone());
+					// set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field === 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					$update_prices = true;
+				}
+			}
+			// cap ticket qty by datetime reg limits
+			$TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
+			// update ticket.
+			$TKT->save();
+			// before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
+				$TKT->save();
+			}
+			// initially let's add the ticket to the dtt
+			$saved_dtt->_add_relation_to($TKT, 'Ticket');
+			$saved_tickets[ $TKT->ID() ] = $TKT;
+			// add prices to ticket
+			$this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices);
+		}
+		// however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			// get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			// need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($dtts as $dtt) {
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			// finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return [$saved_dtt, $saved_tickets];
+	}
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices     Array of prices from the form.
+	 * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
+	{
+		foreach ($prices as $row => $prc) {
+			$PRC_values = [
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			];
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$PRC = EE_Registry::instance()->load_class('Price', [$PRC_values], false, false);
+			} else {
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				// update this price with new values
+				foreach ($PRC_values as $field => $newprc) {
+					$PRC->set($field, $newprc);
+				}
+				$PRC->save();
+			}
+			$ticket->_add_relation_to($PRC, 'Price');
+		}
+	}
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+	}
+
+
+	/**
+	 *    _generate_publish_box_extra_content
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		// load formatter helper
+		// args for getting related registrations
+		$approved_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			],
+		];
+		$not_approved_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			],
+		];
+		$pending_payment_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			],
+		];
+		// publish box
+		$publish_box_extra_args = [
+			'view_approved_reg_url'        => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				],
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		];
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		$use_advanced_editor = $this->admin_config->useAdvancedEditor();
+		/** @var FeatureFlags $flags */
+		$flags = $this->loader->getShared('EventEspresso\core\domain\services\capabilities\FeatureFlags');
+		// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+		if (! $use_advanced_editor || ! $flags->featureAllowed('use_reg_options_meta_box')) {
+			add_meta_box(
+				'espresso_event_editor_event_options',
+				esc_html__('Event Registration Options', 'event_espresso'),
+				[$this, 'registration_options_meta_box'],
+				$this->page_slug,
+				'side'
+			);
+		}
+		if (! $use_advanced_editor) {
+			add_meta_box(
+				'espresso_event_editor_tickets',
+				esc_html__('Event Datetime & Ticket', 'event_espresso'),
+				[$this, 'ticket_metabox'],
+				$this->page_slug,
+				'normal',
+				'high'
+			);
+		} else {
+			if ($flags->featureAllowed('use_reg_options_meta_box')) {
+				add_action(
+					'add_meta_boxes_espresso_events',
+					function () {
+						global $current_screen;
+						remove_meta_box('authordiv', $current_screen, 'normal');
+					},
+					99
+				);
+			}
+		}
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = [];
+		// defaults for template args
+		$template_args = [
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'ee-lock-icon',
+			'disabled'                 => '',
+		];
+		$event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		$times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		// do we get related tickets?
+		if (
+			$first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time'] = $first_datetime;
+			$related_tickets = $first_datetime->tickets(
+				[
+					['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
+					'default_where_conditions' => 'none',
+				]
+			);
+			if (! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[] = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket $ticket */
+			$ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure'] = $this->_get_ticket_row(
+			EE_Registry::instance()->load_model('Ticket')->create_default_object(),
+			true
+		);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket   the ticket object
+	 * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int       $row
+	 * @return string generated html for the ticket row.
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = [
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		];
+		$price = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
+			: EE_Registry::instance()->load_model('Price')->create_default_object();
+		$price_args = [
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		];
+		// make sure we have default start and end dates if skeleton
+		// handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			// if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			// get the earliest datetime (if present);
+			$earliest_dtt = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					['order_by' => ['DTT_EVT_start' => 'ASC']]
+				)
+				: null;
+			if (! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
+			} else {
+				$template_args['TKT_end_date'] = date(
+					'Y-m-d h:i a',
+					mktime(0, 0, 0, date('m'), date('d') + 7, date('Y'))
+				);
+			}
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	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,
+			],
+			true
+		);
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$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['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_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array an array of event objects.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEME = $this->_event_model();
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $count ? null : $offset . ',' . $per_page;
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		if (isset($this->_req_data['month_range'])) {
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
+			// simulate the FIRST day of the month, that fixes issues for months like February
+			// where PHP doesn't know what to assume for date.
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where = [];
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		// determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				break;
+			case 'draft':
+				$where['status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['status'] = $status;
+		}
+		// categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT'] : null;
+		if (! empty($category)) {
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
+			$where['Term_Taxonomy.term_id'] = $category;
+		}
+		// date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] !== '') {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone('UTC')
+			);
+			$start = $DateTime->getTimestamp();
+			// set the datetime to be the end of the month
+			$DateTime->setDate(
+				$year_r,
+				$month_r,
+				$DateTime->format('t')
+			)->setTime(23, 59, 59);
+			$end = $DateTime->getTimestamp();
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif (isset($this->_req_data['status']) && $this->_req_data['status'] === 'today') {
+			$DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif (isset($this->_req_data['status']) && $this->_req_data['status'] === 'month') {
+			$now = date('Y-m-01');
+			$DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+							->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		}
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} elseif (
+			! isset($where['status'])
+				  && ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')
+		) {
+			$where['OR'] = [
+				'status*restrict_private' => ['!=', 'private'],
+				'AND'                     => [
+					'status*inclusive' => ['=', 'private'],
+					'EVT_wp_user'      => get_current_user_id(),
+				],
+			];
+		}
+
+		if (
+			isset($this->_req_data['EVT_wp_user'])
+			&& (int) $this->_req_data['EVT_wp_user'] !== (int) get_current_user_id()
+			&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+		) {
+			$where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
+		}
+		// search query handling
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = [
+				'EVT_name'       => ['LIKE', $search_string],
+				'EVT_desc'       => ['LIKE', $search_string],
+				'EVT_short_desc' => ['LIKE', $search_string],
+			];
+		}
+		// filter events by venue.
+		if (isset($this->_req_data['venue']) && ! empty($this->_req_data['venue'])) {
+			$where['Venue.VNU_ID'] = absint($this->_req_data['venue']);
+		}
+		$where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
+		$query_params = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			[
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			],
+			$this->_req_data
+		);
+
+		// let's first check if we have special requests coming in.
+		if (isset($this->_req_data['active_status'])) {
+			switch ($this->_req_data['active_status']) {
+				case 'upcoming':
+					return $EEME->get_upcoming_events($query_params, $count);
+					break;
+				case 'expired':
+					return $EEME->get_expired_events($query_params, $count);
+					break;
+				case 'active':
+					return $EEME->get_active_events($query_params, $count);
+					break;
+				case 'inactive':
+					return $EEME->get_inactive_events($query_params, $count);
+					break;
+			}
+		}
+
+		$events = $count ? $EEME->count([$where], 'EVT_ID', true) : $EEME->get_all($query_params);
+		return $events;
+	}
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		throw new EE_Error(esc_html__('Please contact Event Espresso support with the details of the steps taken to produce this error.', 'event_espresso'));
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_delete_event();
+	}
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @param bool   $redirect_after
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		// determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if (! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (! empty($event_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : [];
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access  private
+	 * @param int    $EVT_ID
+	 * @param string $event_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if (! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook = 'AHEE_event_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * _delete_event
+	 *
+	 * @access protected
+	 * @param bool $redirect_after
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_event()
+	{
+		$this->generateDeletionPreview(isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : []);
+	}
+
+	/**
+	 * Gets the tree traversal batch persister.
+	 * @since 4.10.12.p
+	 * @return NodeGroupDao
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getModelObjNodeGroupPersister()
+	{
+		if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+			$this->model_obj_node_group_persister = $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
+		}
+		return $this->model_obj_node_group_persister;
+	}
+
+	/**
+	 * _delete_events
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_events()
+	{
+		$this->generateDeletionPreview(isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : []);
+	}
+
+	protected function generateDeletionPreview($event_ids)
+	{
+		$event_ids = (array) $event_ids;
+		// Set a code we can use to reference this deletion task in the batch jobs and preview page.
+		$deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
+		$return_url = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'preview_deletion',
+				'deletion_job_code' => $deletion_job_code,
+			],
+			$this->_admin_base_url
+		);
+		$event_ids = array_map(
+			'intval',
+			$event_ids
+		);
+
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'              => 'espresso_batch',
+					'batch'             => EED_Batch::batch_job,
+					'EVT_IDs'           => $event_ids,
+					'deletion_job_code' => $deletion_job_code,
+					'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
+					'return_url'        => urlencode($return_url),
+				],
+				admin_url()
+			)
+		);
+	}
+
+	/**
+	 * Checks for a POST submission
+	 * @since 4.10.12.p
+	 */
+	protected function confirmDeletion()
+	{
+		$deletion_redirect_logic = $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
+		$deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
+	}
+
+	/**
+	 * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
+	 * @since 4.10.12.p
+	 * @throws EE_Error
+	 */
+	protected function previewDeletion()
+	{
+		$preview_deletion_logic = $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
+		$this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function total_events()
+	{
+		$count = EEM_Event::instance()->count(['caps' => 'read_admin'], 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function total_events_draft()
+	{
+		$where = [
+			'status' => ['IN', ['draft', 'auto-draft']],
+		];
+		$count = EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function total_trashed_events()
+	{
+		$where = [
+			'status' => 'trash',
+		];
+		$count = EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		// exclude
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'update_default_event_settings',
+				'html_id'         => 'update_default_event_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					[
+						'default_reg_status'  => new EE_Select_Input(
+							$registration_stati_for_selection,
+							[
+								'default'         => isset($registration_config->default_STS_ID)
+													 && array_key_exists(
+														 $registration_config->default_STS_ID,
+														 $registration_stati_for_selection
+													 )
+									? sanitize_text_field($registration_config->default_STS_ID)
+									: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													 . EEH_Template::get_help_tab_link(
+														 'default_settings_status_help_tab'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								),
+							]
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							[
+								'default'         => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								)
+													 . EEH_Template::get_help_tab_link(
+														 'default_maximum_tickets_help_tab"'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_default_event_settings()
+	{
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$registration_config = EE_Registry::instance()->CFG->registration;
+				$valid_data = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				do_action(
+					'AHEE__Events_Admin_Page___update_default_event_settings',
+					$valid_data,
+					EE_Registry::instance()->CFG,
+					$this
+				);
+				// update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
+	}
+
+
+	/*************        Templates        *************/
+	protected function _template_settings()
+	{
+		$this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img'] = '<img src="'
+											   . EVENTS_ASSETS_URL
+											   . '/images/'
+											   . 'caffeinated_template_features.jpg" alt="'
+											   . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+											   . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		// set default category object
+		$this->_set_empty_category_object();
+		// only set if we've got an id
+		if (! isset($this->_req_data['EVT_CAT_ID'])) {
+			return;
+		}
+		$category_id = absint($this->_req_data['EVT_CAT_ID']);
+		$term = get_term($category_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+		if (! empty($term)) {
+			$this->_category->category_name = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc = $term->description;
+			$this->_category->id = $term->term_id;
+			$this->_category->parent = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details view.
+	 *
+	 * @param string $view
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+		$route = $view === 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		// custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'category_list'],
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details content.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms = get_terms(
+			[EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 */
+	protected function _delete_categories()
+	{
+		$cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
+			: (array) $this->_req_data['category_id'];
+		foreach ($cat_ids as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	/**
+	 * Handles deleting specific category.
+	 *
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+	}
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 *
+	 * @param bool $new_category true means we're triggering the insert of a new category.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Inserts or updates category
+	 *
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+		// was the category_identifier input disabled?
+		if (isset($this->_req_data['category_identifier'])) {
+			$term_args['slug'] = $this->_req_data['category_identifier'];
+		}
+		$insert_ids = $update
+			? wp_update_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
+			: wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
+		if (! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$cat_id = $insert_ids['term_id'];
+			$msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+		return $cat_id;
+	}
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 *
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$limit = ($current_page - 1) * $per_page;
+		$where = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $sstr],
+				'description' => ['LIKE', $sstr],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+		$categories = $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+		return $categories;
+	}
+
+	/* end category stuff */
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function save_timezonestring_setting()
+	{
+		$timezone_string = isset($this->_req_data['timezone_selected'])
+			? $this->_req_data['timezone_selected']
+			: '';
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
+			EE_Error::add_error(
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, ['action' => 'create_new']);
+	}
 }

core/services/form/meta/InputOptions.php

Indentation +102 added lines, -102 removed lines

@@ -15,106 +15,106 @@
 class InputOptions implements JsonableInterface
 {
 
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
-
-    /**
-     * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
-     *
-     * @var array
-     */
-    private $options = [];
-
-
-    /**
-     * HelpText constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param array           $options
-     */
-    public function __construct(JsonDataHandler $json_data_handler, array $options)
-    {
-        $this->json_data_handler = $json_data_handler;
-        $this->setOptions($options);
-    }
-
-
-    /**
-     * @param string $json
-     * @return InputOptions
-     */
-    public static function fromJson(string $json): InputOptions
-    {
-        $json_data_handler = new JsonDataHandler();
-        $json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
-        $data = $json_data_handler->decodeJson($json);
-        return new InputOptions($json_data_handler, $data ?? []);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return array_values($this->options);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function toJson(): string
-    {
-        return $this->json_data_handler->encodeData($this->toArray());
-    }
-
-
-    /**
-     * an array where keys are option values and values are option labels
-     *
-     * @return array
-     */
-    public function options(): array
-    {
-        return $this->options;
-    }
-
-
-    /**
-     * @param array $option
-     */
-    public function addOption(array $option): void
-    {
-        if (isset($option['label'], $option['value'])) {
-            $label = sanitize_text_field($option['label']);
-            $value = sanitize_key($option['value']);
-
-            // use `value` as key
-            $this->options[ $value ] = compact('label', 'value');
-        }
-    }
-
-
-    /**
-     * @param int|float|string $option_value
-     */
-    public function removeOption(string $option_value): void
-    {
-        $option_value = sanitize_key($option_value);
-        unset($this->options[ $option_value ]);
-    }
-
-
-    /**
-     * @param array $options an array where keys are option values and values are option labels
-     */
-    public function setOptions(array $options): void
-    {
-        foreach ($options as $option) {
-            $this->addOption($option);
-        }
-    }
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
+
+	/**
+	 * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
+	 *
+	 * @var array
+	 */
+	private $options = [];
+
+
+	/**
+	 * HelpText constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param array           $options
+	 */
+	public function __construct(JsonDataHandler $json_data_handler, array $options)
+	{
+		$this->json_data_handler = $json_data_handler;
+		$this->setOptions($options);
+	}
+
+
+	/**
+	 * @param string $json
+	 * @return InputOptions
+	 */
+	public static function fromJson(string $json): InputOptions
+	{
+		$json_data_handler = new JsonDataHandler();
+		$json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
+		$data = $json_data_handler->decodeJson($json);
+		return new InputOptions($json_data_handler, $data ?? []);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return array_values($this->options);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function toJson(): string
+	{
+		return $this->json_data_handler->encodeData($this->toArray());
+	}
+
+
+	/**
+	 * an array where keys are option values and values are option labels
+	 *
+	 * @return array
+	 */
+	public function options(): array
+	{
+		return $this->options;
+	}
+
+
+	/**
+	 * @param array $option
+	 */
+	public function addOption(array $option): void
+	{
+		if (isset($option['label'], $option['value'])) {
+			$label = sanitize_text_field($option['label']);
+			$value = sanitize_key($option['value']);
+
+			// use `value` as key
+			$this->options[ $value ] = compact('label', 'value');
+		}
+	}
+
+
+	/**
+	 * @param int|float|string $option_value
+	 */
+	public function removeOption(string $option_value): void
+	{
+		$option_value = sanitize_key($option_value);
+		unset($this->options[ $option_value ]);
+	}
+
+
+	/**
+	 * @param array $options an array where keys are option values and values are option labels
+	 */
+	public function setOptions(array $options): void
+	{
+		foreach ($options as $option) {
+			$this->addOption($option);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
             $value = sanitize_key($option['value']);
 
             // use `value` as key
-            $this->options[ $value ] = compact('label', 'value');
+            $this->options[$value] = compact('label', 'value');
         }
     }
 
@@ -104,7 +104,7 @@ 
     public function removeOption(string $option_value): void
     {
         $option_value = sanitize_key($option_value);
-        unset($this->options[ $option_value ]);
+        unset($this->options[$option_value]);
     }
 
 

core/services/orm/tree_traversal/NodeGroupDao.php

Indentation +98 added lines, -98 removed lines

@@ -22,110 +22,110 @@
  */
 class NodeGroupDao
 {
-    /**
-     * @return mixed|void
-     */
-    public function generateGroupCode()
-    {
-        return wp_generate_password(6, false);
-    }
+	/**
+	 * @return mixed|void
+	 */
+	public function generateGroupCode()
+	{
+		return wp_generate_password(6, false);
+	}
 
-    /**
-     * Gets the string we put in front of the WP Option name used to store the jobs.
-     *
-     * @return string
-     */
-    private function getOptionPrefix()
-    {
-        return 'ee_deletion_';
-    }
+	/**
+	 * Gets the string we put in front of the WP Option name used to store the jobs.
+	 *
+	 * @return string
+	 */
+	private function getOptionPrefix()
+	{
+		return 'ee_deletion_';
+	}
 
-    /**
-     * @param $code
-     * @return ModelObjNode[]
-     * @throws UnexpectedEntityException
-     */
-    public function getModelObjNodesInGroup($code)
-    {
-        if (! $code) {
-            throw new Exception(esc_html__('We aren’t sure which job you are performing. Please press back in your browser and try again.', 'event_espresso'));
-        }
-        $deletion_data = get_option($this->getOptionPrefix() . $code, []);
-        foreach ($deletion_data as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-        }
-        return $deletion_data;
-    }
+	/**
+	 * @param $code
+	 * @return ModelObjNode[]
+	 * @throws UnexpectedEntityException
+	 */
+	public function getModelObjNodesInGroup($code)
+	{
+		if (! $code) {
+			throw new Exception(esc_html__('We aren’t sure which job you are performing. Please press back in your browser and try again.', 'event_espresso'));
+		}
+		$deletion_data = get_option($this->getOptionPrefix() . $code, []);
+		foreach ($deletion_data as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+		}
+		return $deletion_data;
+	}
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function getModelsAndIdsContainedIn($model_obj_nodes)
-    {
-        $models_and_ids_to_delete = [];
-        foreach ($model_obj_nodes as $root) {
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        return $models_and_ids_to_delete;
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function getModelsAndIdsContainedIn($model_obj_nodes)
+	{
+		$models_and_ids_to_delete = [];
+		foreach ($model_obj_nodes as $root) {
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		return $models_and_ids_to_delete;
+	}
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param string $code
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    public function getModelsAndIdsFromGroup($code)
-    {
-        $model_obj_nodes = $this->getModelObjNodesInGroup($code);
-        return $this->getModelsAndIdsContainedIn($model_obj_nodes);
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param string $code
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	public function getModelsAndIdsFromGroup($code)
+	{
+		$model_obj_nodes = $this->getModelObjNodesInGroup($code);
+		return $this->getModelsAndIdsContainedIn($model_obj_nodes);
+	}
 
-    /**
-     * Persists the ModelObjNodes for future requests, using the code for reference.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param string $code
-     * @return bool
-     */
-    public function persistModelObjNodesGroup($model_obj_nodes, $code)
-    {
-        return add_option(
-            $this->getOptionPrefix() . $code,
-            $model_obj_nodes,
-            null,
-            'no'
-        );
-    }
+	/**
+	 * Persists the ModelObjNodes for future requests, using the code for reference.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param string $code
+	 * @return bool
+	 */
+	public function persistModelObjNodesGroup($model_obj_nodes, $code)
+	{
+		return add_option(
+			$this->getOptionPrefix() . $code,
+			$model_obj_nodes,
+			null,
+			'no'
+		);
+	}
 
-    /**
-     * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
-     *
-     * @param $code
-     * @return bool
-     */
-    public function deleteModelObjNodesInGroup($code)
-    {
-        return delete_option($this->getOptionPrefix() . $code);
-    }
+	/**
+	 * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
+	 *
+	 * @param $code
+	 * @return bool
+	 */
+	public function deleteModelObjNodesInGroup($code)
+	{
+		return delete_option($this->getOptionPrefix() . $code);
+	}
 }
 // End of file NodeGroupDao.php
 // Location: EventEspresso\core\services\orm\tree_traversal/NodeGroupDao.php

core/services/orm/tree_traversal/RelationNode.php

Indentation +262 added lines, -262 removed lines

@@ -25,287 +25,287 @@
 class RelationNode extends BaseNode
 {
 
-    /**
-     * @var string|int
-     */
-    protected $id;
+	/**
+	 * @var string|int
+	 */
+	protected $id;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $main_model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $main_model;
 
-    /**
-     * @var int
-     */
-    protected $count;
+	/**
+	 * @var int
+	 */
+	protected $count;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $related_model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $related_model;
 
-    /**
-     * @var ModelObjNode[]
-     */
-    protected $nodes;
+	/**
+	 * @var ModelObjNode[]
+	 */
+	protected $nodes;
 
-    /**
-     * RelationNode constructor.
-     * @param $main_model_obj_id
-     * @param EEM_Base $main_model
-     * @param EEM_Base $related_model
-     * @param array $dont_traverse_models array of model names we DON'T want to traverse
-     */
-    public function __construct(
-        $main_model_obj_id,
-        EEM_Base $main_model,
-        EEM_Base $related_model,
-        array $dont_traverse_models = []
-    ) {
-        $this->id = $main_model_obj_id;
-        $this->main_model = $main_model;
-        $this->related_model = $related_model;
-        $this->nodes = [];
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
+	/**
+	 * RelationNode constructor.
+	 * @param $main_model_obj_id
+	 * @param EEM_Base $main_model
+	 * @param EEM_Base $related_model
+	 * @param array $dont_traverse_models array of model names we DON'T want to traverse
+	 */
+	public function __construct(
+		$main_model_obj_id,
+		EEM_Base $main_model,
+		EEM_Base $related_model,
+		array $dont_traverse_models = []
+	) {
+		$this->id = $main_model_obj_id;
+		$this->main_model = $main_model;
+		$this->related_model = $related_model;
+		$this->nodes = [];
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
 
 
-    /**
-     * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
-     * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
-     *
-     * @param int $model_objects_to_identify
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
-        if ($num_identified < $model_objects_to_identify) {
-            $related_model_objs = $this->related_model->get_all(
-                [
-                    $this->whereQueryParams(),
-                    'limit' => [
-                        count($this->nodes),
-                        $model_objects_to_identify - $num_identified
-                    ]
-                ]
-            );
-            $new_item_nodes = [];
+	/**
+	 * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
+	 * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
+	 *
+	 * @param int $model_objects_to_identify
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
+		if ($num_identified < $model_objects_to_identify) {
+			$related_model_objs = $this->related_model->get_all(
+				[
+					$this->whereQueryParams(),
+					'limit' => [
+						count($this->nodes),
+						$model_objects_to_identify - $num_identified
+					]
+				]
+			);
+			$new_item_nodes = [];
 
-            // Add entity nodes for each of the model objects we fetched.
-            foreach ($related_model_objs as $related_model_obj) {
-                $entity_node = new ModelObjNode($related_model_obj->ID(), $related_model_obj->get_model(), $this->dont_traverse_models);
-                $this->nodes[ $related_model_obj->ID() ] = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
-            }
-            $num_identified += count($new_item_nodes);
-            if ($num_identified < $model_objects_to_identify) {
-                // And lastly do the work.
-                $num_identified += $this->visitAlreadyDiscoveredNodes(
-                    $new_item_nodes,
-                    $model_objects_to_identify - $num_identified
-                );
-            }
-        }
+			// Add entity nodes for each of the model objects we fetched.
+			foreach ($related_model_objs as $related_model_obj) {
+				$entity_node = new ModelObjNode($related_model_obj->ID(), $related_model_obj->get_model(), $this->dont_traverse_models);
+				$this->nodes[ $related_model_obj->ID() ] = $entity_node;
+				$new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+			}
+			$num_identified += count($new_item_nodes);
+			if ($num_identified < $model_objects_to_identify) {
+				// And lastly do the work.
+				$num_identified += $this->visitAlreadyDiscoveredNodes(
+					$new_item_nodes,
+					$model_objects_to_identify - $num_identified
+				);
+			}
+		}
 
-        if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
-            $this->complete = true;
-        }
-        return $num_identified;
-    }
+		if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
+			$this->complete = true;
+		}
+		return $num_identified;
+	}
 
-    /**
-     * Checks if all the identified child nodes are complete or not.
-     *
-     * @return bool
-     */
-    protected function allChildrenComplete()
-    {
-        foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * Checks if all the identified child nodes are complete or not.
+	 *
+	 * @return bool
+	 */
+	protected function allChildrenComplete()
+	{
+		foreach ($this->nodes as $model_obj_node) {
+			if (! $model_obj_node->isComplete()) {
+				return false;
+			}
+		}
+		return true;
+	}
 
-    /**
-     * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param $work_budget
-     * @return int
-     */
-    protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
-    {
-        $work_done = 0;
-        if (! $model_obj_nodes) {
-            return 0;
-        }
-        foreach ($model_obj_nodes as $model_obj_node) {
-            if ($work_done >= $work_budget) {
-                break;
-            }
-            $work_done += $model_obj_node->visit($work_budget - $work_done);
-        }
-        return $work_done;
-    }
+	/**
+	 * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param $work_budget
+	 * @return int
+	 */
+	protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
+	{
+		$work_done = 0;
+		if (! $model_obj_nodes) {
+			return 0;
+		}
+		foreach ($model_obj_nodes as $model_obj_node) {
+			if ($work_done >= $work_budget) {
+				break;
+			}
+			$work_done += $model_obj_node->visit($work_budget - $work_done);
+		}
+		return $work_done;
+	}
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->count !== null;
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->count !== null;
+	}
 
-    /**
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            if (count($this->nodes) === $this->count) {
-                $this->complete = true;
-            } else {
-                $this->complete = false;
-            }
-        }
-        return $this->complete;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			if (count($this->nodes) === $this->count) {
+				$this->complete = true;
+			} else {
+				$this->complete = false;
+			}
+		}
+		return $this->complete;
+	}
 
-    /**
-     * Discovers how many related model objects exist.
-     *
-     * @return mixed|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function discover()
-    {
-        $this->count = $this->related_model->count([$this->whereQueryParams()]);
-    }
+	/**
+	 * Discovers how many related model objects exist.
+	 *
+	 * @return mixed|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function discover()
+	{
+		$this->count = $this->related_model->count([$this->whereQueryParams()]);
+	}
 
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function whereQueryParams()
-    {
-        $where_params =  [
-            $this->related_model->get_foreign_key_to(
-                $this->main_model->get_this_model_name()
-            )->get_name() => $this->id
-        ];
-        try {
-            $relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
-        } catch (EE_Error $e) {
-            // This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
-            // which hasn't been explicitly declared in the main model object's model's relations.
-            $relation_settings = null;
-        }
-        if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] = $this->main_model->get_this_model_name();
-        }
-        return $where_params;
-    }
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $tree = [
-            'count' => $this->count,
-            'complete' => $this->isComplete(),
-            'objs' => []
-        ];
-        foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
-        }
-        return $tree;
-    }
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function whereQueryParams()
+	{
+		$where_params =  [
+			$this->related_model->get_foreign_key_to(
+				$this->main_model->get_this_model_name()
+			)->get_name() => $this->id
+		];
+		try {
+			$relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
+		} catch (EE_Error $e) {
+			// This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
+			// which hasn't been explicitly declared in the main model object's model's relations.
+			$relation_settings = null;
+		}
+		if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
+			$where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] = $this->main_model->get_this_model_name();
+		}
+		return $where_params;
+	}
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'count' => $this->count,
+			'complete' => $this->isComplete(),
+			'objs' => []
+		];
+		foreach ($this->nodes as $id => $model_obj_node) {
+			$tree['objs'][ $id ] = $model_obj_node->toArray();
+		}
+		return $tree;
+	}
 
-    /**
-     * Gets the IDs of all the model objects to delete; indexed first by model object name.
-     *
-     * @return array
-     */
-    public function getIds()
-    {
-        if (empty($this->nodes)) {
-            return [];
-        }
-        $ids = [
-            $this->related_model->get_this_model_name() => array_combine(
-                array_keys($this->nodes),
-                array_keys($this->nodes)
-            )
-        ];
-        foreach ($this->nodes as $model_obj_node) {
-            $ids = array_replace_recursive($ids, $model_obj_node->getIds());
-        }
-        return $ids;
-    }
+	/**
+	 * Gets the IDs of all the model objects to delete; indexed first by model object name.
+	 *
+	 * @return array
+	 */
+	public function getIds()
+	{
+		if (empty($this->nodes)) {
+			return [];
+		}
+		$ids = [
+			$this->related_model->get_this_model_name() => array_combine(
+				array_keys($this->nodes),
+				array_keys($this->nodes)
+			)
+		];
+		foreach ($this->nodes as $model_obj_node) {
+			$ids = array_replace_recursive($ids, $model_obj_node->getIds());
+		}
+		return $ids;
+	}
 
-    /**
-     * Returns the number of sub-nodes found (ie, related model objects across this relation.)
-     *
-     * @return int
-     */
-    public function countSubNodes()
-    {
-        return count($this->nodes);
-    }
+	/**
+	 * Returns the number of sub-nodes found (ie, related model objects across this relation.)
+	 *
+	 * @return int
+	 */
+	public function countSubNodes()
+	{
+		return count($this->nodes);
+	}
 
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->m = $this->main_model->get_this_model_name();
-        $this->rm = $this->related_model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'rm',
-                'id',
-                'count',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->main_model->get_this_model_name();
+		$this->rm = $this->related_model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'rm',
+				'id',
+				'count',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
 
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->main_model = EE_Registry::instance()->load_model($this->m);
-        $this->related_model = EE_Registry::instance()->load_model($this->rm);
-        parent::__wakeup();
-    }
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->main_model = EE_Registry::instance()->load_model($this->m);
+		$this->related_model = EE_Registry::instance()->load_model($this->rm);
+		parent::__wakeup();
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php

core/db_models/fields/EE_JSON_Field.php

Indentation +64 added lines, -64 removed lines

@@ -5,76 +5,76 @@
 class EE_JSON_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
 
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct(
-        $table_column,
-        $nicename,
-        $nullable,
-        $default_value = null
-    ) {
-        $this->json_data_handler = new JsonDataHandler();
-        $this->json_data_handler->configure(
-            JsonDataHandler::DATA_TYPE_OBJECT
-        );
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct(
+		$table_column,
+		$nicename,
+		$nullable,
+		$default_value = null
+	) {
+		$this->json_data_handler = new JsonDataHandler();
+		$this->json_data_handler->configure(
+			JsonDataHandler::DATA_TYPE_OBJECT
+		);
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
 
-    // /**
-    //  * When get() is called on a model object (eg EE_Event), before returning its value,
-    //  * call this function on it, allowing us to customize the returned value based on
-    //  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-    //  * we simply return it.
-    //  *
-    //  * @param mixed $value_of_field_on_model_object
-    //  * @return mixed
-    //  */
-    // public function prepare_for_get($value_of_field_on_model_object)
-    // {
-    //     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
-    //     return $value_of_field_on_model_object;
-    // }
+	// /**
+	//  * When get() is called on a model object (eg EE_Event), before returning its value,
+	//  * call this function on it, allowing us to customize the returned value based on
+	//  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	//  * we simply return it.
+	//  *
+	//  * @param mixed $value_of_field_on_model_object
+	//  * @return mixed
+	//  */
+	// public function prepare_for_get($value_of_field_on_model_object)
+	// {
+	//     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
+	//     return $value_of_field_on_model_object;
+	// }
 
 
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
+	}
 
 
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_of_field_on_model_object);
-    }
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_of_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Foreign_Key_String_Field.php

Indentation +34 added lines, -34 removed lines

@@ -2,41 +2,41 @@
 
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
-    /**
-     * Whether the value should be converted to uppercase on insertion.
-     *
-     * @var boolean
-     */
-    protected $is_uppercase;
+	/**
+	 * Whether the value should be converted to uppercase on insertion.
+	 *
+	 * @var boolean
+	 */
+	protected $is_uppercase;
 
 
-    /**
-     * @param string          $table_column  name of column for field
-     * @param string          $nicename      should be internationalized with __('blah','event_espresso')
-     * @param boolean         $nullable
-     * @param int|string      $default_value data type should match field type
-     * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
-     *                                       Basically its the model class's name without the "EEM_"
-     * @param boolean         $is_uppercase  Whether the value should be converted to uppercase on insertion.
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name, $is_uppercase = true)
-    {
-        $this->is_uppercase = $is_uppercase;
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-    }
+	/**
+	 * @param string          $table_column  name of column for field
+	 * @param string          $nicename      should be internationalized with __('blah','event_espresso')
+	 * @param boolean         $nullable
+	 * @param int|string      $default_value data type should match field type
+	 * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
+	 *                                       Basically its the model class's name without the "EEM_"
+	 * @param boolean         $is_uppercase  Whether the value should be converted to uppercase on insertion.
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name, $is_uppercase = true)
+	{
+		$this->is_uppercase = $is_uppercase;
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        $clean_value = wp_strip_all_tags($value_inputted_for_field_on_model_object);
-        return $this->is_uppercase ? strtoupper($clean_value) : $clean_value;
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		$clean_value = wp_strip_all_tags($value_inputted_for_field_on_model_object);
+		return $this->is_uppercase ? strtoupper($clean_value) : $clean_value;
+	}
 }

core/db_models/EEM_Form_Element.model.php

Indentation +217 added lines, -217 removed lines

@@ -28,237 +28,237 @@
 class EEM_Form_Element extends EEM_Base
 {
 
-    /**
-     * @var EEM_Form_Element
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Form_Element
+	 */
+	protected static $_instance;
 
-    /**
-     * @var RequestInterface
-     */
-    private $request;
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
 
-    /**
-     * @var InputTypes
-     */
-    private $input_types;
+	/**
+	 * @var InputTypes
+	 */
+	private $input_types;
 
 
-    /**
-     * EEM_Form_Element constructor.
-     *
-     * @param FormStatus  $form_status
-     * @param InputTypes  $input_types
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(FormStatus $form_status, InputTypes $input_types, ?string $timezone)
-    {
-        $this->input_types   = $input_types;
-        $this->singular_item = esc_html__('Form Element', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Elements', 'event_espresso');
+	/**
+	 * EEM_Form_Element constructor.
+	 *
+	 * @param FormStatus  $form_status
+	 * @param InputTypes  $input_types
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(FormStatus $form_status, InputTypes $input_types, ?string $timezone)
+	{
+		$this->input_types   = $input_types;
+		$this->singular_item = esc_html__('Form Element', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Elements', 'event_espresso');
 
-        $this->_tables          = [
-            'Form_Element' => new EE_Primary_Table('esp_form_element', 'FIN_UUID'),
-        ];
-        $this->_fields          = [
-            'Form_Element' => [
-                'FIN_UUID'      => new EE_Primary_Key_String_Field(
-                    'FIN_UUID',
-                    esc_html__('Form Element UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_UUID' => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('UUID of parent form section this form input belongs to.', 'event_espresso'),
-                    false,
-                    null,
-                    ['Form_Section'],
-                    false
-                ),
-                'FIN_adminOnly' => new EE_Boolean_Field(
-                    'FIN_adminOnly',
-                    esc_html__(
-                        'Whether or not input is only displayed in the admin. If false, input will appear in public forms',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'FIN_attributes' => new EE_JSON_Field(
-                    'FIN_attributes',
-                    esc_html__(
-                        'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_helpText' => new EE_JSON_Field(
-                    'FIN_helpText',
-                    esc_html__(
-                        'JSON string of properties pertaining to any help text required for an input.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_label' => new EE_JSON_Field(
-                    'FIN_label',
-                    esc_html__(
-                        'JSON string of properties pertaining to an element\'s label.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_mapsTo'     => new EE_Plain_Text_Field(
-                    'FIN_mapsTo',
-                    esc_html__(
-                        'Model and Fields name that this element maps to; ex: Attendee.email',
-                        'event_espresso'
-                    ),
-                    true,
-                    null
-                ),
-                'FIN_options'     => new EE_JSON_Field(
-                    'FIN_options',
-                    esc_html__(
-                        'JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '[]'
-                ),
-                'FIN_order'     => new EE_Integer_Field(
-                    'FIN_order',
-                    esc_html__('Order in which form input appears in a form.', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'FIN_required' => new EE_JSON_Field(
-                    'FIN_required',
-                    esc_html__(
-                        'properties pertaining to an input\'s required status and the validation text to display.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'FIN_status'    => new EE_Enum_Text_Field(
-                    'FIN_status',
-                    esc_html(
-                        sprintf(
-                            /* translators: 1 class name */
-                            __(
-                                'Whether form element is active, archived, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
-                                'event_espresso'
-                            ),
-                            'EventEspresso\core\services\form\meta\FormStatus'
-                        )
-                    ),
-                    false,
-                    FormStatus::ACTIVE,
-                    $form_status->validStatusOptions()
-                ),
-                'FIN_type'    => new EE_Enum_Text_Field(
-                    'FIN_type',
-                    esc_html__('Form element type.', 'event_espresso'),
-                    false,
-                    false,
-                    $input_types->validTypeOptions()
-                ),
-                'FIN_wpUser'    => new EE_WP_User_Field(
-                    'FIN_wpUser',
-                    esc_html__('ID of the WP User that created this form input.', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
+		$this->_tables          = [
+			'Form_Element' => new EE_Primary_Table('esp_form_element', 'FIN_UUID'),
+		];
+		$this->_fields          = [
+			'Form_Element' => [
+				'FIN_UUID'      => new EE_Primary_Key_String_Field(
+					'FIN_UUID',
+					esc_html__('Form Element UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_UUID' => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('UUID of parent form section this form input belongs to.', 'event_espresso'),
+					false,
+					null,
+					['Form_Section'],
+					false
+				),
+				'FIN_adminOnly' => new EE_Boolean_Field(
+					'FIN_adminOnly',
+					esc_html__(
+						'Whether or not input is only displayed in the admin. If false, input will appear in public forms',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'FIN_attributes' => new EE_JSON_Field(
+					'FIN_attributes',
+					esc_html__(
+						'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_helpText' => new EE_JSON_Field(
+					'FIN_helpText',
+					esc_html__(
+						'JSON string of properties pertaining to any help text required for an input.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_label' => new EE_JSON_Field(
+					'FIN_label',
+					esc_html__(
+						'JSON string of properties pertaining to an element\'s label.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_mapsTo'     => new EE_Plain_Text_Field(
+					'FIN_mapsTo',
+					esc_html__(
+						'Model and Fields name that this element maps to; ex: Attendee.email',
+						'event_espresso'
+					),
+					true,
+					null
+				),
+				'FIN_options'     => new EE_JSON_Field(
+					'FIN_options',
+					esc_html__(
+						'JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.',
+						'event_espresso'
+					),
+					true,
+					'[]'
+				),
+				'FIN_order'     => new EE_Integer_Field(
+					'FIN_order',
+					esc_html__('Order in which form input appears in a form.', 'event_espresso'),
+					false,
+					0
+				),
+				'FIN_required' => new EE_JSON_Field(
+					'FIN_required',
+					esc_html__(
+						'properties pertaining to an input\'s required status and the validation text to display.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'FIN_status'    => new EE_Enum_Text_Field(
+					'FIN_status',
+					esc_html(
+						sprintf(
+							/* translators: 1 class name */
+							__(
+								'Whether form element is active, archived, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
+								'event_espresso'
+							),
+							'EventEspresso\core\services\form\meta\FormStatus'
+						)
+					),
+					false,
+					FormStatus::ACTIVE,
+					$form_status->validStatusOptions()
+				),
+				'FIN_type'    => new EE_Enum_Text_Field(
+					'FIN_type',
+					esc_html__('Form element type.', 'event_espresso'),
+					false,
+					false,
+					$input_types->validTypeOptions()
+				),
+				'FIN_wpUser'    => new EE_WP_User_Field(
+					'FIN_wpUser',
+					esc_html__('ID of the WP User that created this form input.', 'event_espresso'),
+					false
+				),
+			],
+		];
 
-        $this->_model_relations = [
-            'Form_Section' => new EE_Belongs_To_Relation(),
-            'WP_User'      => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators = [
-            EEM_Base::caps_read       => new EE_Restriction_Generator_Public(),
-            EEM_Base::caps_read_admin => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-            EEM_Base::caps_edit       => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-            EEM_Base::caps_delete     => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-        ];
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
+		$this->_model_relations = [
+			'Form_Section' => new EE_Belongs_To_Relation(),
+			'WP_User'      => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators = [
+			EEM_Base::caps_read       => new EE_Restriction_Generator_Public(),
+			EEM_Base::caps_read_admin => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+			EEM_Base::caps_edit       => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+			EEM_Base::caps_delete     => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+		];
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
 
 
-    /**
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
-        $query_params['default_where_conditions'] = $admin_request
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
+	/**
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
+		$query_params['default_where_conditions'] = $admin_request
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
 
 
-    /**
-     * form inputs should always be sorted in ascending order via the FIN_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FIN_order' => 'ASC'];
-        return $query_params;
-    }
+	/**
+	 * form inputs should always be sorted in ascending order via the FIN_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FIN_order' => 'ASC'];
+		return $query_params;
+	}
 
 
-    /**
-     * @param EE_Form_Section $form_section
-     * @param EE_Form_Element[] $all_form_elements
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function filterFormElementsForFormSection(EE_Form_Section $form_section, array $all_form_elements): array
-    {
-        return array_filter($all_form_elements, $form_section->formElementFilter());
-    }
+	/**
+	 * @param EE_Form_Section $form_section
+	 * @param EE_Form_Element[] $all_form_elements
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function filterFormElementsForFormSection(EE_Form_Section $form_section, array $all_form_elements): array
+	{
+		return array_filter($all_form_elements, $form_section->formElementFilter());
+	}
 
 
-    /**
-     * @param EE_Form_Section[] $form_sections
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllFormElementsForFormSections(array $form_sections): array
-    {
-        $FSC_UUIDs = [];
-        foreach ($form_sections as $form_section) {
-            if ($form_section instanceof EE_Form_Section) {
-                $FSC_UUIDs[] = $form_section->UUID();
-            }
-        }
-        $where_params = ['FSC_UUID' => ['IN', $FSC_UUIDs]];
-        $query_params = $this->addDefaultWhereConditions([$where_params]);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
+	/**
+	 * @param EE_Form_Section[] $form_sections
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllFormElementsForFormSections(array $form_sections): array
+	{
+		$FSC_UUIDs = [];
+		foreach ($form_sections as $form_section) {
+			if ($form_section instanceof EE_Form_Section) {
+				$FSC_UUIDs[] = $form_section->UUID();
+			}
+		}
+		$where_params = ['FSC_UUID' => ['IN', $FSC_UUIDs]];
+		$query_params = $this->addDefaultWhereConditions([$where_params]);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
 
 
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $this->input_types->validTypeOptions($constants_only);
-    }
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $this->input_types->validTypeOptions($constants_only);
+	}
 }

core/db_classes/EE_Form_Element.class.php

Indentation +467 added lines, -467 removed lines

@@ -29,471 +29,471 @@
 class EE_Form_Element extends EE_Base_Class
 {
 
-    /**
-     * @var Attributes
-     */
-    private $attributes;
-
-    /**
-     * @var FormLabel
-     */
-    private $label;
-
-    /**
-     * @var HelpText
-     */
-    private $helpText;
-
-    /**
-     * @var InputOptions
-     */
-    private $options;
-
-    /**
-     * @var Required
-     */
-    private $required;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Element
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(array $props_n_values = []): EE_Form_Element
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Element
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = []): EE_Form_Element
-    {
-        return new self($props_n_values);
-    }
-
-
-    /**
-     * Form Element UUID (universally unique identifier)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function UUID(): string
-    {
-        return $this->get('FIN_UUID');
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setUUID(string $UUID)
-    {
-        $this->set('FIN_UUID', $UUID);
-    }
-
-
-    /**
-     * Whether or not input is only displayed in the admin. If false, input will appear in public forms
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function adminOnly(): ?bool
-    {
-        return $this->get('FIN_adminOnly');
-    }
-
-
-    /**
-     * @param bool $admin_only
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAdminOnly(bool $admin_only)
-    {
-        $this->set('FIN_adminOnly', $admin_only);
-    }
-
-
-    /**
-     * JSON string of HTML attributes such as class, max, min, placeholder, type, etc.
-     *
-     * @return Attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attributes(): ?Attributes
-    {
-        if (! $this->attributes instanceof Attributes) {
-            $this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
-        }
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param Attributes $attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAttributes(Attributes $attributes)
-    {
-        // set local object
-        $this->attributes = $attributes;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_attributes', $attributes->toArray());
-    }
-
-
-    /**
-     * UUID of parent form section this form input belongs to.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function belongsTo(): string
-    {
-        return $this->get('FSC_UUID');
-    }
-
-
-    /**
-     * @param string $relation_UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setBelongsTo(string $relation_UUID)
-    {
-        $this->set('FSC_UUID', $relation_UUID);
-    }
-
-
-    /**
-     * returns a HelpText object for managing input help text
-     *
-     * @return HelpText
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function helpText(): ?HelpText
-    {
-        if (! $this->helpText instanceof HelpText) {
-            $this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
-        }
-        return $this->helpText;
-    }
-
-
-    /**
-     * @param HelpText $helpText
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setHelpText(HelpText $helpText)
-    {
-        // set local object
-        $this->helpText = $helpText;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_helpText', $helpText->toArray());
-    }
-
-
-    /**
-     * returns a FormLabel object for managing input labels
-     *
-     * @return FormLabel
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function label(): ?FormLabel
-    {
-        if (! $this->label instanceof FormLabel) {
-            $this->label = FormLabel::fromJson($this->get('FIN_label'));
-        }
-        return $this->label;
-    }
-
-
-    /**
-     * @param FormLabel $label
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setLabel(FormLabel $label)
-    {
-        // set local object
-        $this->label = $label;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_label', $label->toArray());
-    }
-
-
-    /**
-     * Model and Fields name that this input maps to; ex: Attendee.email
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function mapsTo(): ?string
-    {
-        return $this->get('FIN_mapsTo');
-    }
-
-
-    /**
-     * @param string $model ex: Attendee
-     * @param string $field ex: email
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setMapsTo(string $model, string $field)
-    {
-        $model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
-        if (! class_exists($model_name)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s model does not exist or can not be located. Please verify the spelling and whether it is loaded.',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        $this->set('FIN_mapsTo', "{$model}.{$field}");
-    }
-
-
-    /**
-     * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
-     *
-     * @return InputOptions
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function options(): ?InputOptions
-    {
-        if (! $this->options instanceof InputOptions) {
-            $this->options = InputOptions::fromJson($this->get('FIN_options'));
-        }
-        return $this->options;
-    }
-
-
-    /**
-     * @param InputOptions $options
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOptions(InputOptions $options)
-    {
-        // set local object
-        $this->options = $options;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_options', $options->toArray());
-    }
-
-
-
-    /**
-     * Order in which form input appears in a form.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return $this->get('FIN_order');
-    }
-
-
-    /**
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOrder(int $order)
-    {
-        $this->set('FIN_order', $order);
-    }
-
-
-    /**
-     * Example text displayed within an input to assist users with completing the form.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function placeholder(): ?string
-    {
-        return $this->get('FIN_placeholder');
-    }
-
-
-    /**
-     * @param string $placeholder
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setPlaceholder(string $placeholder)
-    {
-        $this->set('FIN_placeholder', $placeholder);
-    }
-
-
-    /**
-     * Whether or not the input must be supplied with a value in order to complete the form.
-     *
-     * @return Required
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function required(): ?Required
-    {
-        if (! $this->required instanceof Required) {
-            $this->required = Required::fromJson($this->get('FIN_required'));
-        }
-        return $this->required;
-    }
-
-
-    /**
-     * @param Required $required
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setRequired(Required $required)
-    {
-        // set local object
-        $this->required = $required;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_required', $required->toArray());
-    }
-
-
-    /**
-     * version of public label for use in identifiers
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug(): ?string
-    {
-        return sanitize_title($this->label()->publicLabel());
-    }
-
-
-    /**
-     * Whether form input is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Element::STATUS_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function status(): string
-    {
-        return $this->get('FIN_status');
-    }
-
-
-    /**
-     * Whether form input is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Element::STATUS_* constants.
-     *
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setStatus(string $status)
-    {
-        $this->set('FIN_status', $status);
-    }
-
-
-    /**
-     * Form input type.
-     * Values correspond to the EventEspresso\core\domain\entities\form\Input::TYPE_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type(): ?string
-    {
-        return $this->get('FIN_type');
-    }
-
-
-    /**
-     * @param string $type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setType(string $type)
-    {
-        $this->set('FIN_type', $type);
-    }
-
-
-    /**
-     * ID of the WP User that created this form input.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return $this->get('FIN_wpUser');
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @param int $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setWpUser(int $wp_user)
-    {
-        $this->set('FIN_wpUser', $wp_user);
-    }
-
-
-    /**
-     * @param array $set_cols_n_values
-     * @return bool|int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        // make sure internal versions for all composite objects are updated
-        $this->set('FIN_attributes', $this->attributes()->toArray());
-        $this->set('FIN_helpText', $this->helpText()->toArray());
-        $this->set('FIN_label', $this->label()->toArray());
-        $this->set('FIN_options', $this->options()->toArray());
-        $this->set('FIN_required', $this->required()->toArray());
-        return parent::save($set_cols_n_values);
-    }
+	/**
+	 * @var Attributes
+	 */
+	private $attributes;
+
+	/**
+	 * @var FormLabel
+	 */
+	private $label;
+
+	/**
+	 * @var HelpText
+	 */
+	private $helpText;
+
+	/**
+	 * @var InputOptions
+	 */
+	private $options;
+
+	/**
+	 * @var Required
+	 */
+	private $required;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Element
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(array $props_n_values = []): EE_Form_Element
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Element
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = []): EE_Form_Element
+	{
+		return new self($props_n_values);
+	}
+
+
+	/**
+	 * Form Element UUID (universally unique identifier)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function UUID(): string
+	{
+		return $this->get('FIN_UUID');
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setUUID(string $UUID)
+	{
+		$this->set('FIN_UUID', $UUID);
+	}
+
+
+	/**
+	 * Whether or not input is only displayed in the admin. If false, input will appear in public forms
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function adminOnly(): ?bool
+	{
+		return $this->get('FIN_adminOnly');
+	}
+
+
+	/**
+	 * @param bool $admin_only
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAdminOnly(bool $admin_only)
+	{
+		$this->set('FIN_adminOnly', $admin_only);
+	}
+
+
+	/**
+	 * JSON string of HTML attributes such as class, max, min, placeholder, type, etc.
+	 *
+	 * @return Attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attributes(): ?Attributes
+	{
+		if (! $this->attributes instanceof Attributes) {
+			$this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
+		}
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param Attributes $attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAttributes(Attributes $attributes)
+	{
+		// set local object
+		$this->attributes = $attributes;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_attributes', $attributes->toArray());
+	}
+
+
+	/**
+	 * UUID of parent form section this form input belongs to.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function belongsTo(): string
+	{
+		return $this->get('FSC_UUID');
+	}
+
+
+	/**
+	 * @param string $relation_UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setBelongsTo(string $relation_UUID)
+	{
+		$this->set('FSC_UUID', $relation_UUID);
+	}
+
+
+	/**
+	 * returns a HelpText object for managing input help text
+	 *
+	 * @return HelpText
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function helpText(): ?HelpText
+	{
+		if (! $this->helpText instanceof HelpText) {
+			$this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
+		}
+		return $this->helpText;
+	}
+
+
+	/**
+	 * @param HelpText $helpText
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setHelpText(HelpText $helpText)
+	{
+		// set local object
+		$this->helpText = $helpText;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_helpText', $helpText->toArray());
+	}
+
+
+	/**
+	 * returns a FormLabel object for managing input labels
+	 *
+	 * @return FormLabel
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function label(): ?FormLabel
+	{
+		if (! $this->label instanceof FormLabel) {
+			$this->label = FormLabel::fromJson($this->get('FIN_label'));
+		}
+		return $this->label;
+	}
+
+
+	/**
+	 * @param FormLabel $label
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setLabel(FormLabel $label)
+	{
+		// set local object
+		$this->label = $label;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_label', $label->toArray());
+	}
+
+
+	/**
+	 * Model and Fields name that this input maps to; ex: Attendee.email
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function mapsTo(): ?string
+	{
+		return $this->get('FIN_mapsTo');
+	}
+
+
+	/**
+	 * @param string $model ex: Attendee
+	 * @param string $field ex: email
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setMapsTo(string $model, string $field)
+	{
+		$model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
+		if (! class_exists($model_name)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s model does not exist or can not be located. Please verify the spelling and whether it is loaded.',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		$this->set('FIN_mapsTo', "{$model}.{$field}");
+	}
+
+
+	/**
+	 * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
+	 *
+	 * @return InputOptions
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function options(): ?InputOptions
+	{
+		if (! $this->options instanceof InputOptions) {
+			$this->options = InputOptions::fromJson($this->get('FIN_options'));
+		}
+		return $this->options;
+	}
+
+
+	/**
+	 * @param InputOptions $options
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOptions(InputOptions $options)
+	{
+		// set local object
+		$this->options = $options;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_options', $options->toArray());
+	}
+
+
+
+	/**
+	 * Order in which form input appears in a form.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return $this->get('FIN_order');
+	}
+
+
+	/**
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOrder(int $order)
+	{
+		$this->set('FIN_order', $order);
+	}
+
+
+	/**
+	 * Example text displayed within an input to assist users with completing the form.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function placeholder(): ?string
+	{
+		return $this->get('FIN_placeholder');
+	}
+
+
+	/**
+	 * @param string $placeholder
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setPlaceholder(string $placeholder)
+	{
+		$this->set('FIN_placeholder', $placeholder);
+	}
+
+
+	/**
+	 * Whether or not the input must be supplied with a value in order to complete the form.
+	 *
+	 * @return Required
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function required(): ?Required
+	{
+		if (! $this->required instanceof Required) {
+			$this->required = Required::fromJson($this->get('FIN_required'));
+		}
+		return $this->required;
+	}
+
+
+	/**
+	 * @param Required $required
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setRequired(Required $required)
+	{
+		// set local object
+		$this->required = $required;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_required', $required->toArray());
+	}
+
+
+	/**
+	 * version of public label for use in identifiers
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug(): ?string
+	{
+		return sanitize_title($this->label()->publicLabel());
+	}
+
+
+	/**
+	 * Whether form input is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Element::STATUS_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function status(): string
+	{
+		return $this->get('FIN_status');
+	}
+
+
+	/**
+	 * Whether form input is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Element::STATUS_* constants.
+	 *
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setStatus(string $status)
+	{
+		$this->set('FIN_status', $status);
+	}
+
+
+	/**
+	 * Form input type.
+	 * Values correspond to the EventEspresso\core\domain\entities\form\Input::TYPE_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type(): ?string
+	{
+		return $this->get('FIN_type');
+	}
+
+
+	/**
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setType(string $type)
+	{
+		$this->set('FIN_type', $type);
+	}
+
+
+	/**
+	 * ID of the WP User that created this form input.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('FIN_wpUser');
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @param int $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setWpUser(int $wp_user)
+	{
+		$this->set('FIN_wpUser', $wp_user);
+	}
+
+
+	/**
+	 * @param array $set_cols_n_values
+	 * @return bool|int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		// make sure internal versions for all composite objects are updated
+		$this->set('FIN_attributes', $this->attributes()->toArray());
+		$this->set('FIN_helpText', $this->helpText()->toArray());
+		$this->set('FIN_label', $this->label()->toArray());
+		$this->set('FIN_options', $this->options()->toArray());
+		$this->set('FIN_required', $this->required()->toArray());
+		return parent::save($set_cols_n_values);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -137,7 +137,7 @@ 
      */
     public function attributes(): ?Attributes
     {
-        if (! $this->attributes instanceof Attributes) {
+        if ( ! $this->attributes instanceof Attributes) {
             $this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
         }
         return $this->attributes;
@@ -191,7 +191,7 @@ 
      */
     public function helpText(): ?HelpText
     {
-        if (! $this->helpText instanceof HelpText) {
+        if ( ! $this->helpText instanceof HelpText) {
             $this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
         }
         return $this->helpText;
@@ -221,7 +221,7 @@ 
      */
     public function label(): ?FormLabel
     {
-        if (! $this->label instanceof FormLabel) {
+        if ( ! $this->label instanceof FormLabel) {
             $this->label = FormLabel::fromJson($this->get('FIN_label'));
         }
         return $this->label;
@@ -264,7 +264,7 @@ 
     public function setMapsTo(string $model, string $field)
     {
         $model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
-        if (! class_exists($model_name)) {
+        if ( ! class_exists($model_name)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -288,7 +288,7 @@ 
      */
     public function options(): ?InputOptions
     {
-        if (! $this->options instanceof InputOptions) {
+        if ( ! $this->options instanceof InputOptions) {
             $this->options = InputOptions::fromJson($this->get('FIN_options'));
         }
         return $this->options;
@@ -367,7 +367,7 @@ 
      */
     public function required(): ?Required
     {
-        if (! $this->required instanceof Required) {
+        if ( ! $this->required instanceof Required) {
             $this->required = Required::fromJson($this->get('FIN_required'));
         }
         return $this->required;