eventespresso / event-espresso-core

admin_pages/events/help_tours/Event_Edit_Help_Tour.class.php

Indentation +221 added lines, -221 removed lines

@@ -15,243 +15,243 @@
 class Event_Edit_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Event Editor Tour', 'event_espresso');
-        $this->_slug = $this->_is_caf ? 'event-edit-caf-joyride' : 'event-edit-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Event Editor Tour', 'event_espresso');
+		$this->_slug = $this->_is_caf ? 'event-edit-caf-joyride' : 'event-edit-joyride';
+	}
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'id'      => 'titlewrap',
-                'content' => $this->_event_title_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            30 => array(
-                'id'      => 'wp-content-editor-tools',
-                'content' => $this->_event_description_stop(),
-                'options' => array(
-                    'tipLocation' => 'right',
-                ),
-            ),
-            35 => array(
-                'id'      => 'espresso_event_editor_tickets',
-                'content' => $this->_event_pricing_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40 => array(
-                'id'      => 'espresso_events_Venues_Hooks_venue_metabox_metabox',
-                'content' => $this->_event_venues_caf(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            45 => array(
-                'id'      => 'espresso_event_editor_venue',
-                'content' => $this->_event_venues_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50 => array(
-                'id'      => 'espresso_events_Pricing_Hooks_pricing_metabox_metabox',
-                'content' => $this->_event_pricing_caf(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            60 => array(
-                'id'      => 'tagsdiv-post_tag',
-                'content' => $this->_event_post_tag_stop(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-            70 => array(
-                'id'      => 'espresso_event_categoriesdiv',
-                'content' => $this->_event_categories_stop(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'id'      => 'titlewrap',
+				'content' => $this->_event_title_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -40,
+				),
+			),
+			30 => array(
+				'id'      => 'wp-content-editor-tools',
+				'content' => $this->_event_description_stop(),
+				'options' => array(
+					'tipLocation' => 'right',
+				),
+			),
+			35 => array(
+				'id'      => 'espresso_event_editor_tickets',
+				'content' => $this->_event_pricing_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40 => array(
+				'id'      => 'espresso_events_Venues_Hooks_venue_metabox_metabox',
+				'content' => $this->_event_venues_caf(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -30,
+				),
+			),
+			45 => array(
+				'id'      => 'espresso_event_editor_venue',
+				'content' => $this->_event_venues_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50 => array(
+				'id'      => 'espresso_events_Pricing_Hooks_pricing_metabox_metabox',
+				'content' => $this->_event_pricing_caf(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -30,
+				),
+			),
+			60 => array(
+				'id'      => 'tagsdiv-post_tag',
+				'content' => $this->_event_post_tag_stop(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+			70 => array(
+				'id'      => 'espresso_event_categoriesdiv',
+				'content' => $this->_event_categories_stop(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
 
-            80  => array(
-                'id'      => $this->_is_caf ? 'espresso_events_Registration_Form_Hooks_Extend_primary_questions_metabox'
-                    : 'espresso_events_Registration_Form_Hooks_primary_questions_metabox',
-                'content' => $this->_primary_question_stop_caf(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-            90  => array(
-                'id'      => 'espresso_events_Registration_Form_Hooks_Extend_additional_questions_metabox',
-                'content' => $this->_additional_questions_stop_caf(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-            100 => array(
-                'id'      => 'postimagediv',
-                'content' => $this->_featured_image_stop(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-            110 => array(
-                'id'      => 'espresso_event_editor_event_options',
-                'content' => $this->_event_registration_options_stop(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-            120 => array(
-                'id'      => 'submitpost',
-                'content' => $this->_publish_event_stop(),
-                'options' => array(
-                    'tipLocation' => 'left',
-                ),
-            ),
-        );
+			80  => array(
+				'id'      => $this->_is_caf ? 'espresso_events_Registration_Form_Hooks_Extend_primary_questions_metabox'
+					: 'espresso_events_Registration_Form_Hooks_primary_questions_metabox',
+				'content' => $this->_primary_question_stop_caf(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+			90  => array(
+				'id'      => 'espresso_events_Registration_Form_Hooks_Extend_additional_questions_metabox',
+				'content' => $this->_additional_questions_stop_caf(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+			100 => array(
+				'id'      => 'postimagediv',
+				'content' => $this->_featured_image_stop(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+			110 => array(
+				'id'      => 'espresso_event_editor_event_options',
+				'content' => $this->_event_registration_options_stop(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+			120 => array(
+				'id'      => 'submitpost',
+				'content' => $this->_publish_event_stop(),
+				'options' => array(
+					'tipLocation' => 'left',
+				),
+			),
+		);
 
-        if (EE_Config::instance()->admin->useAdvancedEditor()) {
-            unset(
-                // description
-                $this->_stops[30],
-                // tickets
-                $this->_stops[35],
-                // venues
-                $this->_stops[40],
-                $this->_stops[45],
-                // pricing
-                $this->_stops[50],
-                // questions
-                $this->_stops[90],
-                // reg options
-                $this->_stops[110]
-            );
-        }
-    }
+		if (EE_Config::instance()->admin->useAdvancedEditor()) {
+			unset(
+				// description
+				$this->_stops[30],
+				// tickets
+				$this->_stops[35],
+				// venues
+				$this->_stops[40],
+				$this->_stops[45],
+				// pricing
+				$this->_stops[50],
+				// questions
+				$this->_stops[90],
+				// reg options
+				$this->_stops[110]
+			);
+		}
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Event Editor', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Event Editor will provide an overview of the different areas of the screen to help you understand what they are used for. Let\'s get started on setting up your first event with Event Espresso!',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Event Editor', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Event Editor will provide an overview of the different areas of the screen to help you understand what they are used for. Let\'s get started on setting up your first event with Event Espresso!',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
 
-    protected function _event_title_stop()
-    {
-        return '<p>Enter the title for your event in this field.</p>';
-    }
+	protected function _event_title_stop()
+	{
+		return '<p>Enter the title for your event in this field.</p>';
+	}
 
-    protected function _event_description_stop()
-    {
-        return '<p>'
-               . __(
-                   'The rich text editor can be used to add information about your event. Images and links can also be added along with your text.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_description_stop()
+	{
+		return '<p>'
+			   . __(
+				   'The rich text editor can be used to add information about your event. Images and links can also be added along with your text.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_venues_caf()
-    {
-        return '<p>'
-               . __(
-                   'In this section, you can select the venue that is hosting your event.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_venues_caf()
+	{
+		return '<p>'
+			   . __(
+				   'In this section, you can select the venue that is hosting your event.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_venues_stop()
-    {
-        return '<p>'
-               . __(
-                   'In this section, you can enter information about the venue that is hosting your event.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_venues_stop()
+	{
+		return '<p>'
+			   . __(
+				   'In this section, you can enter information about the venue that is hosting your event.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_pricing_stop()
-    {
-        return '<p>'
-               . __(
-                   'Use the Event Datetime & Ticket section to enter details about when the event is happening and what tickets you want to offer for access to the event.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_pricing_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Use the Event Datetime & Ticket section to enter details about when the event is happening and what tickets you want to offer for access to the event.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_pricing_caf()
-    {
-        return '<p>'
-               . __(
-                   'Use the Event Datetimes & Ticket section to enter details about when the event is happening and what tickets you want to offer for access to the event.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_pricing_caf()
+	{
+		return '<p>'
+			   . __(
+				   'Use the Event Datetimes & Ticket section to enter details about when the event is happening and what tickets you want to offer for access to the event.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_registration_options_stop()
-    {
-        return '<p>' . __('Setup custom options for your event registration.', 'event_espresso') . '</p>';
-    }
+	protected function _event_registration_options_stop()
+	{
+		return '<p>' . __('Setup custom options for your event registration.', 'event_espresso') . '</p>';
+	}
 
-    protected function _event_post_tag_stop()
-    {
-        return '<p>' . __('Quickly add tags to your event.', 'event_espresso') . '</p>';
-    }
+	protected function _event_post_tag_stop()
+	{
+		return '<p>' . __('Quickly add tags to your event.', 'event_espresso') . '</p>';
+	}
 
-    protected function _event_categories_stop()
-    {
-        return '<p>' . __('Events can also be categorized if you wish.', 'event_espresso') . '</p>';
-    }
+	protected function _event_categories_stop()
+	{
+		return '<p>' . __('Events can also be categorized if you wish.', 'event_espresso') . '</p>';
+	}
 
-    protected function _primary_question_stop_caf()
-    {
-        return '<p>'
-               . __(
-                   'Use the questions group to request information from your primary registrant.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _primary_question_stop_caf()
+	{
+		return '<p>'
+			   . __(
+				   'Use the questions group to request information from your primary registrant.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _additional_questions_stop_caf()
-    {
-        return '<p>'
-               . __(
-                   'Use the questions group to request information from your additional registrant.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _additional_questions_stop_caf()
+	{
+		return '<p>'
+			   . __(
+				   'Use the questions group to request information from your additional registrant.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _featured_image_stop()
-    {
-        return '<p>' . __('Set a feature image for your event here.', 'event_espresso') . '</p>';
-    }
+	protected function _featured_image_stop()
+	{
+		return '<p>' . __('Set a feature image for your event here.', 'event_espresso') . '</p>';
+	}
 
-    protected function _publish_event_stop()
-    {
-        return '<p>'
-               . __(
-                   'Easily control the state of your event. The main states are Published, Pending Review, and Draft. Additional states are Cancelled, Postponed, and Sold Out.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _publish_event_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Easily control the state of your event. The main states are Published, Pending Review, and Draft. Additional states are Cancelled, Postponed, and Sold Out.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

admin_pages/venues/espresso_events_Venues_Hooks.class.php

Indentation +212 added lines, -212 removed lines

@@ -15,216 +15,216 @@
 class espresso_events_Venues_Hooks extends EE_Admin_Hooks
 {
 
-    /**
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        parent::__construct($admin_page);
-    }
-
-
-    protected function _set_hooks_properties()
-    {
-
-        $this->_name = 'venues';
-
-        if (EE_Config::instance()->admin->useAdvancedEditor()) {
-            $this->_metaboxes = [];
-            $this->_scripts_styles = [];
-            return;
-        }
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'venue_metabox',
-                'label'      => __('Venue Details', 'event_espresso'),
-                'priority'   => 'high',
-                'context'    => 'normal',
-            ),
-        );
-
-        $this->_scripts_styles = array(
-            'registers' => array(
-                'ee_event_venues'     => array(
-                    'type'    => 'js',
-                    'url'     => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.js',
-                    'depends' => array('jquery'),
-                ),
-                'ee_event_venues_css' => array(
-                    'type' => 'css',
-                    'url'  => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.css',
-                ),
-            ),
-            'enqueues'  => array(
-                'ee_event_venues'     => array('edit', 'create_new'),
-                'ee_event_venues_css' => array('edit', 'create_new'),
-            ),
-        );
-
-        // hook into the handler for saving venue
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'modify_callbacks'),
-            10
-        );
-
-        // remove default ee_autosave returns for DECAF venues (not needed for CAF venues cause we have a dropdown selector)
-        add_filter('FHEE__Events_Admin_Page__ee_autosave_edit_do_decaf_venue_save', '__return_false');
-    }
-
-
-    public function modify_callbacks($callbacks)
-    {
-        // first remove default venue callback
-        foreach ($callbacks as $key => $callback) {
-            if ($callback[1] == '_default_venue_update') {
-                unset($callbacks[ $key ]);
-            }
-        }
-
-        // now let's add the caf version
-        $callbacks[] = array($this, 'caf_venue_update');
-        return $callbacks;
-    }
-
-
-    public function venue_metabox()
-    {
-        $evt_obj = $this->_adminpage_obj->get_event_object();
-        $evt_id = $evt_obj->ID();
-
-        // first let's see if we have a venue already
-        $evt_venues = ! empty($evt_id) ? $evt_obj->venues() : array();
-        $evt_venue = $evt_venues && is_array($evt_venues) ? reset($evt_venues) : null;
-        $evt_venue_id = $evt_venue instanceof EE_Venue ? $evt_venue->ID() : null;
-
-        // possibly private venues.
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
-            $vnu_where['status'] = array('IN', array('publish', 'private'));
-        } else {
-            $vnu_where['status'] = 'publish';
-        }
-
-        // cap checks
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $vnu_where['VNU_wp_user'] = get_current_user_id();
-        }
-
-        $vnumdl = EE_Registry::instance()->load_model('Venue');
-        $venues = $vnumdl->get_all(array($vnu_where, 'order_by' => array('VNU_name' => 'ASC')));
-
-        $ven_select = array();
-        $ven_select[0] = __('Select a Venue', 'event_espresso');
-        // setup venues for selector
-        foreach ($venues as $venue) {
-            $ven_select[ $venue->ID() ] = $venue->name();
-        }
-
-        // if $ven_select does not have the existing venue attached to event then let's add that because we'll always
-        // show existing attached venues even if it's trashed (or some other restricted status).
-
-        if ($evt_venue_id && ! isset($ven_select[ $evt_venue_id ])) {
-            $ven_select[ $evt_venue_id ] = $evt_venue->name();
-            $venues = array_merge($venues, array($evt_venue));
-        }
-
-        $template_args['venues'] = $venues;
-        $template_args['evt_venue_id'] = $evt_venue_id;
-        $venue_selector = new EE_Select_Input(
-            $ven_select,
-            array(
-                'html_name'  => 'venue_id',
-                'html_id'    => 'venue_id',
-                'html_class' => 'wide',
-                'default'    => $evt_venue_id ? $evt_venue_id : '0'
-            )
-        );
-        $template_args['venue_selector'] = $venue_selector->get_html_for_input();
-        $enable_for_gmap = new EE_Yes_No_Input(
-            array(
-                'html_name'  => 'enable_for_gmap',
-                'html_id'    => 'enable_for_gmap',
-                'default'    => $evt_venue instanceof EE_Venue ? $evt_venue->enable_for_gmap() : false
-            )
-        );
-        $template_args['enable_for_gmap'] = $enable_for_gmap->get_html_for_input();
-        $template_args['new_venue_link'] = EEH_HTML::link(
-            EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'create_new'),
-                EE_VENUES_ADMIN_URL
-            ),
-            esc_html_x('Add new Venue', 'a link to add a new venue', 'event_espresso'),
-            esc_html_x('Add new Venue', 'a link to add a new venue', 'event_espresso'),
-            'ev_new_venue_link',
-            'button',
-            'margin-left:10px;',
-            'target="_blank"'
-        );
-
-        // Decide on an info text when there are no venues to display.
-        $no_venues_info_txt = esc_html_x(
-            'You have not created any venues yet.',
-            'Information text displayed in the venues metabox when there are no venues to display',
-            'event_espresso'
-        );
-        if (empty($venues)) {
-            $unpublished_where = $vnu_where;
-            $unpublished_where['status'] = 'draft';
-            $unpublished_venues = $vnumdl->get_all(array($unpublished_where, 'order_by' => array('VNU_name' => 'ASC')));
-            if (count($unpublished_venues) > 0) {
-                $no_venues_info_txt = esc_html_x(
-                // @codingStandardsIgnoreStart
-                    'Use the link below to publish your venue through the venue editor so it appears here for selection.',
-                    // @codingStandardsIgnoreEnd
-                    'Information text displayed in the venues metabox when there are no venues to display',
-                    'event_espresso'
-                );
-            }
-        }
-        $template_args['no_venues_info'] = EEH_HTML::p(
-            EEH_HTML::strong($no_venues_info_txt),
-            'no_venues_info',
-            'info'
-        );
-
-        $template_path = empty($venues) ? EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content.template.php'
-            : EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content_from_manager.template.php';
-
-        // Allow events venue metabox template args filtering.
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Venues_Hooks___venue_metabox__template_args',
-            $template_args,
-            $template_path
-        );
-
-        EEH_Template::display_template($template_path, $template_args);
-    }
-
-
-    public function caf_venue_update($evtobj, $data)
-    {
-        EE_Registry::instance()->load_model('Venue');
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-
-
-        // first let's check if the selected venue matches any existing venue attached to the event
-        $evt_venue = $evtobj->venues();
-        $evt_venue = ! empty($evt_venue) ? array_shift($evt_venue) : null;
-
-        if (! empty($evt_venue) && $evt_venue->ID() != $venue_id) {
-            $evtobj->_remove_relation_to($evt_venue->ID(), 'Venue');
-        }
-
-        if (empty($venue_id)) {
-            return true;
-        } //no venue to attach
-
-        // this should take care of adding to revisions as well as main post object
-        $success = $evtobj->_add_relation_to($venue_id, 'Venue');
-        return ! empty($success) ? true : false;
-    }
+	/**
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		parent::__construct($admin_page);
+	}
+
+
+	protected function _set_hooks_properties()
+	{
+
+		$this->_name = 'venues';
+
+		if (EE_Config::instance()->admin->useAdvancedEditor()) {
+			$this->_metaboxes = [];
+			$this->_scripts_styles = [];
+			return;
+		}
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'venue_metabox',
+				'label'      => __('Venue Details', 'event_espresso'),
+				'priority'   => 'high',
+				'context'    => 'normal',
+			),
+		);
+
+		$this->_scripts_styles = array(
+			'registers' => array(
+				'ee_event_venues'     => array(
+					'type'    => 'js',
+					'url'     => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.js',
+					'depends' => array('jquery'),
+				),
+				'ee_event_venues_css' => array(
+					'type' => 'css',
+					'url'  => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.css',
+				),
+			),
+			'enqueues'  => array(
+				'ee_event_venues'     => array('edit', 'create_new'),
+				'ee_event_venues_css' => array('edit', 'create_new'),
+			),
+		);
+
+		// hook into the handler for saving venue
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'modify_callbacks'),
+			10
+		);
+
+		// remove default ee_autosave returns for DECAF venues (not needed for CAF venues cause we have a dropdown selector)
+		add_filter('FHEE__Events_Admin_Page__ee_autosave_edit_do_decaf_venue_save', '__return_false');
+	}
+
+
+	public function modify_callbacks($callbacks)
+	{
+		// first remove default venue callback
+		foreach ($callbacks as $key => $callback) {
+			if ($callback[1] == '_default_venue_update') {
+				unset($callbacks[ $key ]);
+			}
+		}
+
+		// now let's add the caf version
+		$callbacks[] = array($this, 'caf_venue_update');
+		return $callbacks;
+	}
+
+
+	public function venue_metabox()
+	{
+		$evt_obj = $this->_adminpage_obj->get_event_object();
+		$evt_id = $evt_obj->ID();
+
+		// first let's see if we have a venue already
+		$evt_venues = ! empty($evt_id) ? $evt_obj->venues() : array();
+		$evt_venue = $evt_venues && is_array($evt_venues) ? reset($evt_venues) : null;
+		$evt_venue_id = $evt_venue instanceof EE_Venue ? $evt_venue->ID() : null;
+
+		// possibly private venues.
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+			$vnu_where['status'] = array('IN', array('publish', 'private'));
+		} else {
+			$vnu_where['status'] = 'publish';
+		}
+
+		// cap checks
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$vnu_where['VNU_wp_user'] = get_current_user_id();
+		}
+
+		$vnumdl = EE_Registry::instance()->load_model('Venue');
+		$venues = $vnumdl->get_all(array($vnu_where, 'order_by' => array('VNU_name' => 'ASC')));
+
+		$ven_select = array();
+		$ven_select[0] = __('Select a Venue', 'event_espresso');
+		// setup venues for selector
+		foreach ($venues as $venue) {
+			$ven_select[ $venue->ID() ] = $venue->name();
+		}
+
+		// if $ven_select does not have the existing venue attached to event then let's add that because we'll always
+		// show existing attached venues even if it's trashed (or some other restricted status).
+
+		if ($evt_venue_id && ! isset($ven_select[ $evt_venue_id ])) {
+			$ven_select[ $evt_venue_id ] = $evt_venue->name();
+			$venues = array_merge($venues, array($evt_venue));
+		}
+
+		$template_args['venues'] = $venues;
+		$template_args['evt_venue_id'] = $evt_venue_id;
+		$venue_selector = new EE_Select_Input(
+			$ven_select,
+			array(
+				'html_name'  => 'venue_id',
+				'html_id'    => 'venue_id',
+				'html_class' => 'wide',
+				'default'    => $evt_venue_id ? $evt_venue_id : '0'
+			)
+		);
+		$template_args['venue_selector'] = $venue_selector->get_html_for_input();
+		$enable_for_gmap = new EE_Yes_No_Input(
+			array(
+				'html_name'  => 'enable_for_gmap',
+				'html_id'    => 'enable_for_gmap',
+				'default'    => $evt_venue instanceof EE_Venue ? $evt_venue->enable_for_gmap() : false
+			)
+		);
+		$template_args['enable_for_gmap'] = $enable_for_gmap->get_html_for_input();
+		$template_args['new_venue_link'] = EEH_HTML::link(
+			EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'create_new'),
+				EE_VENUES_ADMIN_URL
+			),
+			esc_html_x('Add new Venue', 'a link to add a new venue', 'event_espresso'),
+			esc_html_x('Add new Venue', 'a link to add a new venue', 'event_espresso'),
+			'ev_new_venue_link',
+			'button',
+			'margin-left:10px;',
+			'target="_blank"'
+		);
+
+		// Decide on an info text when there are no venues to display.
+		$no_venues_info_txt = esc_html_x(
+			'You have not created any venues yet.',
+			'Information text displayed in the venues metabox when there are no venues to display',
+			'event_espresso'
+		);
+		if (empty($venues)) {
+			$unpublished_where = $vnu_where;
+			$unpublished_where['status'] = 'draft';
+			$unpublished_venues = $vnumdl->get_all(array($unpublished_where, 'order_by' => array('VNU_name' => 'ASC')));
+			if (count($unpublished_venues) > 0) {
+				$no_venues_info_txt = esc_html_x(
+				// @codingStandardsIgnoreStart
+					'Use the link below to publish your venue through the venue editor so it appears here for selection.',
+					// @codingStandardsIgnoreEnd
+					'Information text displayed in the venues metabox when there are no venues to display',
+					'event_espresso'
+				);
+			}
+		}
+		$template_args['no_venues_info'] = EEH_HTML::p(
+			EEH_HTML::strong($no_venues_info_txt),
+			'no_venues_info',
+			'info'
+		);
+
+		$template_path = empty($venues) ? EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content.template.php'
+			: EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content_from_manager.template.php';
+
+		// Allow events venue metabox template args filtering.
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Venues_Hooks___venue_metabox__template_args',
+			$template_args,
+			$template_path
+		);
+
+		EEH_Template::display_template($template_path, $template_args);
+	}
+
+
+	public function caf_venue_update($evtobj, $data)
+	{
+		EE_Registry::instance()->load_model('Venue');
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+
+
+		// first let's check if the selected venue matches any existing venue attached to the event
+		$evt_venue = $evtobj->venues();
+		$evt_venue = ! empty($evt_venue) ? array_shift($evt_venue) : null;
+
+		if (! empty($evt_venue) && $evt_venue->ID() != $venue_id) {
+			$evtobj->_remove_relation_to($evt_venue->ID(), 'Venue');
+		}
+
+		if (empty($venue_id)) {
+			return true;
+		} //no venue to attach
+
+		// this should take care of adding to revisions as well as main post object
+		$success = $evtobj->_add_relation_to($venue_id, 'Venue');
+		return ! empty($success) ? true : false;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -51,12 +51,12 @@ 
             'registers' => array(
                 'ee_event_venues'     => array(
                     'type'    => 'js',
-                    'url'     => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.js',
+                    'url'     => EE_VENUES_ASSETS_URL.'ee-event-venues-admin.js',
                     'depends' => array('jquery'),
                 ),
                 'ee_event_venues_css' => array(
                     'type' => 'css',
-                    'url'  => EE_VENUES_ASSETS_URL . 'ee-event-venues-admin.css',
+                    'url'  => EE_VENUES_ASSETS_URL.'ee-event-venues-admin.css',
                 ),
             ),
             'enqueues'  => array(
@@ -82,7 +82,7 @@ 
         // first remove default venue callback
         foreach ($callbacks as $key => $callback) {
             if ($callback[1] == '_default_venue_update') {
-                unset($callbacks[ $key ]);
+                unset($callbacks[$key]);
             }
         }
 
@@ -110,7 +110,7 @@ 
         }
 
         // cap checks
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
             $vnu_where['VNU_wp_user'] = get_current_user_id();
         }
 
@@ -121,14 +121,14 @@ 
         $ven_select[0] = __('Select a Venue', 'event_espresso');
         // setup venues for selector
         foreach ($venues as $venue) {
-            $ven_select[ $venue->ID() ] = $venue->name();
+            $ven_select[$venue->ID()] = $venue->name();
         }
 
         // if $ven_select does not have the existing venue attached to event then let's add that because we'll always
         // show existing attached venues even if it's trashed (or some other restricted status).
 
-        if ($evt_venue_id && ! isset($ven_select[ $evt_venue_id ])) {
-            $ven_select[ $evt_venue_id ] = $evt_venue->name();
+        if ($evt_venue_id && ! isset($ven_select[$evt_venue_id])) {
+            $ven_select[$evt_venue_id] = $evt_venue->name();
             $venues = array_merge($venues, array($evt_venue));
         }
 
@@ -192,7 +192,7 @@ 
         );
 
         $template_path = empty($venues) ? EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content.template.php'
-            : EE_VENUES_TEMPLATE_PATH . 'event_venues_metabox_content_from_manager.template.php';
+            : EE_VENUES_TEMPLATE_PATH.'event_venues_metabox_content_from_manager.template.php';
 
         // Allow events venue metabox template args filtering.
         $template_args = apply_filters(
@@ -215,7 +215,7 @@ 
         $evt_venue = $evtobj->venues();
         $evt_venue = ! empty($evt_venue) ? array_shift($evt_venue) : null;
 
-        if (! empty($evt_venue) && $evt_venue->ID() != $venue_id) {
+        if ( ! empty($evt_venue) && $evt_venue->ID() != $venue_id) {
             $evtobj->_remove_relation_to($evt_venue->ID(), 'Venue');
         }
 

core/data_migration_scripts/EE_DMS_Core_4_12_0.dms.php

Indentation +180 added lines, -180 removed lines

@@ -10,9 +10,9 @@ 
 $stages            = glob(EE_CORE . 'data_migration_scripts/4_12_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~4_12_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~4_12_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_12_0__autoloaded_stages', $class_to_filepath);
@@ -28,63 +28,63 @@ 
  */
 class EE_DMS_Core_4_12_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     *
-     * @param EE_DMS_Core_4_11_0 $dms_4_11
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(
-        EE_DMS_Core_4_11_0 $dms_4_11,
-        TableManager $table_manager = null,
-        TableAnalysis $table_analysis = null
-    ) {
-        $this->previous_dms      = $dms_4_11;
-        $this->_pretty_name      = esc_html__("Data Update to Event Espresso 4.12.0", "event_espresso");
-        $this->_priority         = 10;
-        $this->_migration_stages = [
-            new EE_DMS_4_12_0_Event_Venues(),
-        ];
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array): bool
-    {
-        $version_string = $version_array['Core'];
-        return $version_string
-               && version_compare($version_string, '4.12.0.decaf', '<')
-               && version_compare($version_string, '4.11.0.decaf', '>=');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function schema_changes_before_migration(): bool
-    {
-        require_once EE_HELPERS . 'EEH_Activation.helper.php';
-
-        $table_name = 'esp_answer';
-        $sql        = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 *
+	 * @param EE_DMS_Core_4_11_0 $dms_4_11
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(
+		EE_DMS_Core_4_11_0 $dms_4_11,
+		TableManager $table_manager = null,
+		TableAnalysis $table_analysis = null
+	) {
+		$this->previous_dms      = $dms_4_11;
+		$this->_pretty_name      = esc_html__("Data Update to Event Espresso 4.12.0", "event_espresso");
+		$this->_priority         = 10;
+		$this->_migration_stages = [
+			new EE_DMS_4_12_0_Event_Venues(),
+		];
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array): bool
+	{
+		$version_string = $version_array['Core'];
+		return $version_string
+			   && version_compare($version_string, '4.12.0.decaf', '<')
+			   && version_compare($version_string, '4.11.0.decaf', '>=');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function schema_changes_before_migration(): bool
+	{
+		require_once EE_HELPERS . 'EEH_Activation.helper.php';
+
+		$table_name = 'esp_answer';
+		$sql        = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_attendee_meta';
-        $sql        = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_attendee_meta';
+		$sql        = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -101,10 +101,10 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_checkin';
-        $sql        = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_checkin';
+		$sql        = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -112,10 +112,10 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_country';
-        $sql        = "CNT_ISO varchar(2) NOT NULL,
+		$table_name = 'esp_country';
+		$sql        = "CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -131,32 +131,32 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_currency';
-        $sql        = "CUR_code varchar(6) NOT NULL,
+		$table_name = 'esp_currency';
+		$sql        = "CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-
-        // note: although this table is no longer in use,
-        // it hasn't been removed because then queries to the model will have errors.
-        // but you should expect this table and its corresponding model to be removed in
-        // the next few months
-        $table_name = 'esp_currency_payment_method';
-        $sql        = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+
+		// note: although this table is no longer in use,
+		// it hasn't been removed because then queries to the model will have errors.
+		// but you should expect this table and its corresponding model to be removed in
+		// the next few months
+		$table_name = 'esp_currency_payment_method';
+		$sql        = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_datetime';
-        $sql        = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_datetime';
+		$sql        = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
@@ -174,28 +174,28 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = "esp_datetime_ticket";
-        $sql        = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_datetime_ticket";
+		$sql        = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID),
 				KEY DTT_ID (DTT_ID),
 				KEY TKT_ID (TKT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_event_message_template';
-        $sql        = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_event_message_template';
+		$sql        = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_event_meta';
-        $sql        = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_event_meta';
+		$sql        = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -212,10 +212,10 @@ 
 				FSC_UUID varchar(25) DEFAULT NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_event_question_group';
-        $sql        = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_event_question_group';
+		$sql        = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
@@ -223,28 +223,28 @@ 
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_event_venue';
-        $sql        = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_event_venue';
+		$sql        = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_extra_meta';
-        $sql        = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_extra_meta';
+		$sql        = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_extra_join';
-        $sql        = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_extra_join';
+		$sql        = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -252,10 +252,10 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_form_element';
-        $sql        = "FIN_UUID varchar(25) NOT NULL,
+		$table_name = 'esp_form_element';
+		$sql        = "FIN_UUID varchar(25) NOT NULL,
 				FSC_UUID varchar(25) NOT NULL,
 				FIN_adminOnly tinyint(1) unsigned NOT NULL DEFAULT 0,
 				FIN_attributes text DEFAULT NULL,
@@ -272,10 +272,10 @@ 
 				KEY FSC_UUID (FSC_UUID),
 				KEY FIN_order (FIN_order),
 				KEY FIN_status (FIN_status)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_form_section';
-        $sql        = "FSC_UUID varchar(25) NOT NULL,
+		$table_name = 'esp_form_section';
+		$sql        = "FSC_UUID varchar(25) NOT NULL,
 				FSC_appliesTo tinytext NOT NULL,
 				FSC_attributes text DEFAULT NULL,
 				FSC_belongsTo varchar(25) DEFAULT NULL,
@@ -287,10 +287,10 @@ 
 				KEY FSC_belongsTo (FSC_belongsTo),
 				KEY FSC_order (FSC_order),
 				KEY FSC_status (FSC_status)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_form_submission';
-        $sql        = "FSB_UUID varchar(25) NOT NULL,
+		$table_name = 'esp_form_submission';
+		$sql        = "FSB_UUID varchar(25) NOT NULL,
                 FSC_UUID varchar(25) NOT NULL,
 				TXN_ID int(10) DEFAULT NULL,
 				FSB_data mediumtext DEFAULT NULL,
@@ -298,10 +298,10 @@ 
 				PRIMARY KEY  (FSB_UUID),
 				KEY FSC_UUID (FSC_UUID),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name   = 'esp_line_item';
-        $sql          = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name   = 'esp_line_item';
+		$sql          = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(10) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -322,10 +322,10 @@ 
 				KEY txn_type_timestamp (TXN_ID,LIN_type,LIN_timestamp),
 				KEY txn_obj_id_obj_type (TXN_ID,OBJ_ID,OBJ_type),
 				KEY obj_id_obj_type (OBJ_ID,OBJ_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_log';
-        $sql        = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_log';
+		$sql        = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -336,10 +336,10 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_message';
-        $sql        = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_message';
+		$sql        = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -371,20 +371,20 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_message_template';
-        $sql        = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_message_template';
+		$sql        = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_message_template_group';
-        $sql        = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_message_template_group';
+		$sql        = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -396,10 +396,10 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_payment';
-        $sql        = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_payment';
+		$sql        = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
@@ -416,10 +416,10 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_payment_method';
-        $sql        = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_payment_method';
+		$sql        = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -435,10 +435,10 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = "esp_price";
-        $sql        = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_price";
+		$sql        = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -451,10 +451,10 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = "esp_price_type";
-        $sql        = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_price_type";
+		$sql        = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -463,27 +463,27 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = "esp_ticket_price";
-        $sql        = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_ticket_price";
+		$sql        = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID),
 				KEY TKT_ID (TKT_ID),
 				KEY PRC_ID (PRC_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = "esp_ticket_template";
-        $sql        = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_ticket_template";
+		$sql        = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_question';
-        $sql        = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_question';
+		$sql        = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -497,10 +497,10 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_question_group';
-        $sql        = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_question_group';
+		$sql        = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -513,20 +513,20 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_question_group_question';
-        $sql        = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_question_group_question';
+		$sql        = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_question_option';
-        $sql        = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_question_option';
+		$sql        = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -536,10 +536,10 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_registration';
-        $sql        = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_registration';
+		$sql        = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -563,20 +563,20 @@ 
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_registration_payment';
-        $sql        = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_registration_payment';
+		$sql        = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-        $table_name = 'esp_state';
-        $sql        = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_state';
+		$sql        = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
@@ -584,10 +584,10 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_status';
-        $sql        = "STS_ID varchar(3) NOT NULL,
+		$table_name = 'esp_status';
+		$sql        = "STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -595,10 +595,10 @@ 
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 				KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = "esp_ticket";
-        $sql        = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = "esp_ticket";
+		$sql        = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -623,10 +623,10 @@ 
 				TKT_visibility smallint(6) unsigned NOT NULL DEFAULT 100,
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_transaction';
-        $sql        = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_transaction';
+		$sql        = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -638,10 +638,10 @@ 
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp),
 				KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_venue_meta';
-        $sql        = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_venue_meta';
+		$sql        = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -660,18 +660,18 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $this->previous_dms->insert_default_data();
-        return true;
-    }
+		$this->previous_dms->insert_default_data();
+		return true;
+	}
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration(): bool
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration(): bool
+	{
+		return true;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -7,12 +7,12 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages            = glob(EE_CORE . 'data_migration_scripts/4_12_0_stages/*');
+$stages            = glob(EE_CORE.'data_migration_scripts/4_12_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
     $matches = [];
     preg_match('~4_12_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+    $class_to_filepath[$matches[1]] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_12_0__autoloaded_stages', $class_to_filepath);
@@ -71,7 +71,7 @@ 
      */
     public function schema_changes_before_migration(): bool
     {
-        require_once EE_HELPERS . 'EEH_Activation.helper.php';
+        require_once EE_HELPERS.'EEH_Activation.helper.php';
 
         $table_name = 'esp_answer';
         $sql        = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,

core/data_migration_scripts/4_12_0_stages/EE_DMS_4_12_0_Event_Venues.dmsstage.php

Indentation +46 added lines, -46 removed lines

@@ -12,54 +12,54 @@
  */
 class EE_DMS_4_12_0_Event_Venues extends EE_Data_Migration_Script_Stage_Table
 {
-    /**
-     * @var string
-     */
-    private $_event_meta;
+	/**
+	 * @var string
+	 */
+	private $_event_meta;
 
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__('Event Venue Relations', 'event_espresso');
-        $this->_old_table   = $wpdb->prefix . 'esp_event_venue';
-        $this->_event_meta  = $wpdb->prefix . 'esp_event_meta';
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__('Event Venue Relations', 'event_espresso');
+		$this->_old_table   = $wpdb->prefix . 'esp_event_venue';
+		$this->_event_meta  = $wpdb->prefix . 'esp_event_meta';
+		parent::__construct();
+	}
 
 
-    /**
-     * Copies Venue IDs from `wp_esp_event_venue` to `wp_esp_event_meta` for each Event
-     *
-     * @param array $old_row an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($old_row): ?bool
-    {
-        $EVT_ID =
-            isset($old_row['EVT_ID'])
-                ? absint($old_row['EVT_ID'])
-                : 0;
-        $VNU_ID =
-            isset($old_row['VNU_ID'])
-                ? absint($old_row['VNU_ID'])
-                : 0;
-        if ($EVT_ID && $VNU_ID) {
-            global $wpdb;
-            // If the question group was also for primary attendees, we should just update that row.
-            // And we delete this row.
-            $result = $wpdb->update(
-                $this->_event_meta,
-                ['VNU_ID' => $VNU_ID],  // data
-                ['EVT_ID' => $EVT_ID],  // where
-                ['%d'],                 // data format
-                ['%d']                  // where format
-            );
-            return filter_var($result, FILTER_VALIDATE_BOOLEAN);
-        }
-        return false;
-    }
+	/**
+	 * Copies Venue IDs from `wp_esp_event_venue` to `wp_esp_event_meta` for each Event
+	 *
+	 * @param array $old_row an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($old_row): ?bool
+	{
+		$EVT_ID =
+			isset($old_row['EVT_ID'])
+				? absint($old_row['EVT_ID'])
+				: 0;
+		$VNU_ID =
+			isset($old_row['VNU_ID'])
+				? absint($old_row['VNU_ID'])
+				: 0;
+		if ($EVT_ID && $VNU_ID) {
+			global $wpdb;
+			// If the question group was also for primary attendees, we should just update that row.
+			// And we delete this row.
+			$result = $wpdb->update(
+				$this->_event_meta,
+				['VNU_ID' => $VNU_ID],  // data
+				['EVT_ID' => $EVT_ID],  // where
+				['%d'],                 // data format
+				['%d']                  // where format
+			);
+			return filter_var($result, FILTER_VALIDATE_BOOLEAN);
+		}
+		return false;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -25,8 +25,8 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__('Event Venue Relations', 'event_espresso');
-        $this->_old_table   = $wpdb->prefix . 'esp_event_venue';
-        $this->_event_meta  = $wpdb->prefix . 'esp_event_meta';
+        $this->_old_table   = $wpdb->prefix.'esp_event_venue';
+        $this->_event_meta  = $wpdb->prefix.'esp_event_meta';
         parent::__construct();
     }
 
@@ -53,9 +53,9 @@ 
             // And we delete this row.
             $result = $wpdb->update(
                 $this->_event_meta,
-                ['VNU_ID' => $VNU_ID],  // data
-                ['EVT_ID' => $EVT_ID],  // where
-                ['%d'],                 // data format
+                ['VNU_ID' => $VNU_ID], // data
+                ['EVT_ID' => $EVT_ID], // where
+                ['%d'], // data format
                 ['%d']                  // where format
             );
             return filter_var($result, FILTER_VALIDATE_BOOLEAN);

core/db_models/EEM_Datetime.model.php

Indentation +838 added lines, -838 removed lines

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

core/db_models/EEM_Event.model.php

Indentation +927 added lines, -927 removed lines

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

core/helpers/EEH_Event_Query.helper.php

Indentation +671 added lines, -671 removed lines

@@ -15,675 +15,675 @@
 class EEH_Event_Query
 {
 
-    /**
-     * Start Date
-     *
-     * @var $_event_query_month
-     */
-    protected static $_event_query_month;
-
-    /**
-     * Category
-     *
-     * @var $_event_query_category
-     */
-    protected static $_event_query_category;
-
-    /**
-     * whether to display expired events in the event list
-     *
-     * @var bool $_show_expired
-     */
-    protected static $_event_query_show_expired = false;
-
-    /**
-     * list of params for controlling how the query results are ordered
-     *
-     * @var array $_event_query_orderby
-     */
-    protected static $_event_query_orderby = array();
-
-    /**
-     * direction list is sorted
-     *
-     * @var string $_event_query_sort
-     */
-    protected static $_event_query_sort;
-
-    /**
-     * list of params used to build the query's various clauses
-     *
-     * @var $_query_params
-     */
-    protected static $_query_params = array();
-
-
-
-    /**
-     * @return void
-     */
-    public static function add_query_filters()
-    {
-        // add query filters
-        add_action('pre_get_posts', array('EEH_Event_Query', 'filter_query_parts'), 10, 1);
-    }
-
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return bool
-     */
-    public static function apply_query_filters(WP_Query $WP_Query)
-    {
-        return (
-                   isset($WP_Query->query['post_type'])
-                   && $WP_Query->query['post_type'] === 'espresso_events'
-               )
-               || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     */
-    public static function filter_query_parts(WP_Query $WP_Query)
-    {
-        // ONLY add our filters if this isn't the main wp_query,
-        // because if this is the main wp_query we already have
-        // our cpt strategies take care of adding things in.
-        if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
-            // build event list query
-            add_filter('posts_fields', array('EEH_Event_Query', 'posts_fields'), 10, 2);
-            add_filter('posts_join', array('EEH_Event_Query', 'posts_join'), 10, 2);
-            add_filter('posts_where', array('EEH_Event_Query', 'posts_where'), 10, 2);
-            add_filter('posts_orderby', array('EEH_Event_Query', 'posts_orderby'), 10, 2);
-            add_filter('posts_clauses_request', array('EEH_Event_Query', 'posts_clauses'), 10, 2);
-        }
-    }
-
-
-
-    /**
-     * @param string $month
-     * @param string $category
-     * @param bool   $show_expired
-     * @param string $orderby
-     * @param string $sort
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_query_params(
-        $month = '',
-        $category = '',
-        $show_expired = false,
-        $orderby = 'start_date',
-        $sort = 'ASC'
-    ) {
-        self::$_query_params                        = array();
-        EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
-        EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
-        EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
-        EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
-        EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
-    }
-
-
-
-    /**
-     * what month should the event list display events for?
-     *
-     * @param string $month
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _display_month($month = '')
-    {
-        return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_month', $month));
-    }
-
-
-
-    /**
-     * @param string $category
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _event_category_slug($category = '')
-    {
-        return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_category', $category));
-    }
-
-
-
-    /**
-     * @param bool $show_expired
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _show_expired($show_expired = false)
-    {
-        // override default expired option if set via filter
-        return filter_var(
-            EE_Registry::instance()->REQ->get('event_query_show_expired', $show_expired),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-
-    /**
-     * @param    string $orderby
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _orderby($orderby = 'start_date')
-    {
-        $event_query_orderby = EE_Registry::instance()->REQ->get('event_query_orderby', $orderby);
-        $event_query_orderby = is_array($event_query_orderby)
-            ? $event_query_orderby
-            : explode(',', $event_query_orderby);
-        $event_query_orderby = array_map('trim', $event_query_orderby);
-        $event_query_orderby = array_map('sanitize_text_field', $event_query_orderby);
-        return $event_query_orderby;
-    }
-
-
-
-    /**
-     * @param string $sort
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _sort($sort = 'ASC')
-    {
-        $sort = EE_Registry::instance()->REQ->get('event_query_sort', $sort);
-        return in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
-            ? strtoupper($sort)
-            : 'ASC';
-    }
-
-
-
-    /**
-     * Filters the clauses for the WP_Query object
-     *
-     * @param array    $clauses array of clauses
-     * @param WP_Query $wp_query
-     * @return array   array of clauses
-     */
-    public static function posts_clauses($clauses, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
-        }
-        return $clauses;
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param array $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields_sql_for_orderby(array $orderby_params = array())
-    {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
-                    break;
-                case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
-                    break;
-                case 'venue_title':
-                    $SQL .= ', Venue.post_title AS venue_title';
-                    break;
-                case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
-                    break;
-                case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Category
-            $SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
-            $SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
-            $SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string  $SQL
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
-    {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            // don't add if this is already in the SQL
-            if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
-     *                              used for anything yet
-     * @return string
-     */
-    public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
-    {
-        if (! empty($join_terms)) {
-            global $wpdb;
-            $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
-            $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
-            $SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
-     *
-     * @param    string $SQL
-     * @param    array  $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_for_orderby($SQL = '', array $orderby_params = array())
-    {
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                case 'ticket_end':
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime(
-                        $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
-                    );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
-                    $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' )';
-                    break;
-                case 'venue_title':
-                case 'city':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    break;
-                case 'state':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    $SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param string $join
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_datetime($SQL = '', $join = '')
-    {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function _posts_join_for_event_venue(string $SQL = ''): string
-    {
-        // grab venue table PK name & event_meta table name
-        $VNU_ID = EEM_Venue::instance()->primary_key_name();
-        $event_meta = EEM_Event::instance()->second_table();
-        // generate conditions for:  Event <=> Venue  JOIN clause
-        $event_venue_join = "Venue.ID = $event_meta.$VNU_ID";
-        // don't add joins if they have already been added
-        if (strpos($SQL, $event_venue_join) === false) {
-            global $wpdb;
-            // grab wp_posts (event), venue, and venue_meta table names
-            $wp_posts = $wpdb->posts;
-            $venue = EEM_Venue::instance()->table();
-            $venue_meta = EEM_Venue::instance()->second_table();
-            // generate JOIN clause for: Event <=> Event Meta
-            $venue_SQL = " LEFT JOIN $event_meta ON ( $wp_posts.ID = $event_meta.EVT_ID )";
-            // generate JOIN clause for: Event Meta <=> Venue
-            $venue_SQL .= " LEFT JOIN $venue AS Venue ON ( $event_venue_join )";
-            // generate JOIN clause for: Venue <=> Venue Meta
-            $venue_SQL .= " LEFT JOIN $venue_meta ON ( Venue.ID = $venue_meta.$VNU_ID )";
-            unset($venue, $VNU_ID, $event_meta, $venue_meta, $event_venue_join);
-            return $venue_SQL;
-        }
-        unset($VNU_ID, $event_meta, $event_venue_join);
-        return '';
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_venue_state($SQL = '')
-    {
-        // Venue Meta table name
-        $venue_meta_table = EEM_Venue::instance()->second_table();
-        // State table name
-        $state_table = EEM_State::instance()->table();
-        // State table pk
-        $state_table_pk = EEM_State::instance()->primary_key_name();
-        // verify vars
-        if ($venue_meta_table && $state_table && $state_table_pk) {
-            // like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
-            $join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
-            // don't add join if it has already been added
-            if (strpos($SQL, $join) === false) {
-                unset($state_table_pk, $venue_meta_table, $venue_table_pk);
-                return " LEFT JOIN $state_table ON ( $join )";
-            }
-        }
-        unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
-        return '';
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Show Expired ?
-            $SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
-            // Category
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
-            // Start Date
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param    boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
-            : '';
-    }
-
-
-
-    /**
-     * @param boolean $event_category_slug
-     * @return string
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        global $wpdb;
-        if (! empty($event_category_slug)) {
-            $event_category_slugs_array = array_map('trim', explode(',', $event_category_slug));
-            $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
-            return $wpdb->prepare(" AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ", $event_category_slugs_array);
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @param boolean $month
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        $SQL = '';
-        if (! empty($month)) {
-            $datetime_table = EEM_Datetime::instance()->table();
-            // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
-            // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            $SQL = EEH_Event_Query::posts_orderby_sql(
-                EEH_Event_Query::$_event_query_orderby,
-                EEH_Event_Query::$_event_query_sort
-            );
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     *    posts_orderby_sql
-     *    possible parameters:
-     *    ID
-     *    start_date
-     *    end_date
-     *    event_name
-     *    category_slug
-     *    ticket_start
-     *    ticket_end
-     *    venue_title
-     *    city
-     *    state
-     *    **IMPORTANT**
-     *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
-     *    or else some of the table references below will result in MySQL errors
-     *
-     * @param array  $orderby_params
-     * @param string $sort
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby_sql(array $orderby_params = array(), $sort = 'ASC')
-    {
-        global $wpdb;
-        $SQL     = '';
-        $counter = 0;
-        $sort    = in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
-            ? strtoupper($sort)
-            : 'ASC';
-        // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
-            self::$_query_params['orderby'] = array();
-        }
-        // loop thru $orderby_params (type cast as array)
-        foreach ($orderby_params as $orderby) {
-            // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
-                // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
-                // then bump ahead to the next param
-                continue;
-            }
-            // this will ad a comma depending on whether this is the first or last param
-            $glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
-            // ok what's we dealing with?
-            switch ($orderby) {
-                case 'id':
-                case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
-                    break;
-                case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
-                    break;
-                case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
-                    break;
-                case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
-                    break;
-                case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
-                    break;
-                case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
-                    break;
-                case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
-                    break;
-                case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
-                    break;
-                case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
-                    break;
-            }
-            // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
-            $counter++;
-        }
-        return $SQL;
-    }
+	/**
+	 * Start Date
+	 *
+	 * @var $_event_query_month
+	 */
+	protected static $_event_query_month;
+
+	/**
+	 * Category
+	 *
+	 * @var $_event_query_category
+	 */
+	protected static $_event_query_category;
+
+	/**
+	 * whether to display expired events in the event list
+	 *
+	 * @var bool $_show_expired
+	 */
+	protected static $_event_query_show_expired = false;
+
+	/**
+	 * list of params for controlling how the query results are ordered
+	 *
+	 * @var array $_event_query_orderby
+	 */
+	protected static $_event_query_orderby = array();
+
+	/**
+	 * direction list is sorted
+	 *
+	 * @var string $_event_query_sort
+	 */
+	protected static $_event_query_sort;
+
+	/**
+	 * list of params used to build the query's various clauses
+	 *
+	 * @var $_query_params
+	 */
+	protected static $_query_params = array();
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function add_query_filters()
+	{
+		// add query filters
+		add_action('pre_get_posts', array('EEH_Event_Query', 'filter_query_parts'), 10, 1);
+	}
+
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return bool
+	 */
+	public static function apply_query_filters(WP_Query $WP_Query)
+	{
+		return (
+				   isset($WP_Query->query['post_type'])
+				   && $WP_Query->query['post_type'] === 'espresso_events'
+			   )
+			   || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 */
+	public static function filter_query_parts(WP_Query $WP_Query)
+	{
+		// ONLY add our filters if this isn't the main wp_query,
+		// because if this is the main wp_query we already have
+		// our cpt strategies take care of adding things in.
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
+			// build event list query
+			add_filter('posts_fields', array('EEH_Event_Query', 'posts_fields'), 10, 2);
+			add_filter('posts_join', array('EEH_Event_Query', 'posts_join'), 10, 2);
+			add_filter('posts_where', array('EEH_Event_Query', 'posts_where'), 10, 2);
+			add_filter('posts_orderby', array('EEH_Event_Query', 'posts_orderby'), 10, 2);
+			add_filter('posts_clauses_request', array('EEH_Event_Query', 'posts_clauses'), 10, 2);
+		}
+	}
+
+
+
+	/**
+	 * @param string $month
+	 * @param string $category
+	 * @param bool   $show_expired
+	 * @param string $orderby
+	 * @param string $sort
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_query_params(
+		$month = '',
+		$category = '',
+		$show_expired = false,
+		$orderby = 'start_date',
+		$sort = 'ASC'
+	) {
+		self::$_query_params                        = array();
+		EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
+		EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
+		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
+		EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
+		EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
+	}
+
+
+
+	/**
+	 * what month should the event list display events for?
+	 *
+	 * @param string $month
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _display_month($month = '')
+	{
+		return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_month', $month));
+	}
+
+
+
+	/**
+	 * @param string $category
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _event_category_slug($category = '')
+	{
+		return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_category', $category));
+	}
+
+
+
+	/**
+	 * @param bool $show_expired
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _show_expired($show_expired = false)
+	{
+		// override default expired option if set via filter
+		return filter_var(
+			EE_Registry::instance()->REQ->get('event_query_show_expired', $show_expired),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+
+	/**
+	 * @param    string $orderby
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _orderby($orderby = 'start_date')
+	{
+		$event_query_orderby = EE_Registry::instance()->REQ->get('event_query_orderby', $orderby);
+		$event_query_orderby = is_array($event_query_orderby)
+			? $event_query_orderby
+			: explode(',', $event_query_orderby);
+		$event_query_orderby = array_map('trim', $event_query_orderby);
+		$event_query_orderby = array_map('sanitize_text_field', $event_query_orderby);
+		return $event_query_orderby;
+	}
+
+
+
+	/**
+	 * @param string $sort
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _sort($sort = 'ASC')
+	{
+		$sort = EE_Registry::instance()->REQ->get('event_query_sort', $sort);
+		return in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
+			? strtoupper($sort)
+			: 'ASC';
+	}
+
+
+
+	/**
+	 * Filters the clauses for the WP_Query object
+	 *
+	 * @param array    $clauses array of clauses
+	 * @param WP_Query $wp_query
+	 * @return array   array of clauses
+	 */
+	public static function posts_clauses($clauses, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			global $wpdb;
+			$clauses['groupby'] = $wpdb->posts . '.ID ';
+		}
+		return $clauses;
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param array $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields_sql_for_orderby(array $orderby_params = array())
+	{
+		$SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+					break;
+				case 'ticket_end':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+					break;
+				case 'venue_title':
+					$SQL .= ', Venue.post_title AS venue_title';
+					break;
+				case 'city':
+					$SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+					break;
+				case 'state':
+					$SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Category
+			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
+			$SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
+			$SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string  $SQL
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
+	{
+		if (! $show_expired) {
+			$join = EEM_Event::instance()->table() . '.ID = ';
+			$join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			// don't add if this is already in the SQL
+			if (strpos($SQL, $join) === false) {
+				$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
+	 *                              used for anything yet
+	 * @return string
+	 */
+	public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
+	{
+		if (! empty($join_terms)) {
+			global $wpdb;
+			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
+			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
+			$SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	 *
+	 * @param    string $SQL
+	 * @param    array  $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_for_orderby($SQL = '', array $orderby_params = array())
+	{
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+				case 'ticket_end':
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime(
+						$SQL,
+						EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+					);
+					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+					$SQL .= ' ON (';
+					$SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' = ';
+					$SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' )';
+					break;
+				case 'venue_title':
+				case 'city':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					break;
+				case 'state':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					$SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
+					break;
+				case 'start_date':
+				default:
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_datetime($SQL = '', $join = '')
+	{
+		if (! empty($join)) {
+			$join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === false) {
+				return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function _posts_join_for_event_venue(string $SQL = ''): string
+	{
+		// grab venue table PK name & event_meta table name
+		$VNU_ID = EEM_Venue::instance()->primary_key_name();
+		$event_meta = EEM_Event::instance()->second_table();
+		// generate conditions for:  Event <=> Venue  JOIN clause
+		$event_venue_join = "Venue.ID = $event_meta.$VNU_ID";
+		// don't add joins if they have already been added
+		if (strpos($SQL, $event_venue_join) === false) {
+			global $wpdb;
+			// grab wp_posts (event), venue, and venue_meta table names
+			$wp_posts = $wpdb->posts;
+			$venue = EEM_Venue::instance()->table();
+			$venue_meta = EEM_Venue::instance()->second_table();
+			// generate JOIN clause for: Event <=> Event Meta
+			$venue_SQL = " LEFT JOIN $event_meta ON ( $wp_posts.ID = $event_meta.EVT_ID )";
+			// generate JOIN clause for: Event Meta <=> Venue
+			$venue_SQL .= " LEFT JOIN $venue AS Venue ON ( $event_venue_join )";
+			// generate JOIN clause for: Venue <=> Venue Meta
+			$venue_SQL .= " LEFT JOIN $venue_meta ON ( Venue.ID = $venue_meta.$VNU_ID )";
+			unset($venue, $VNU_ID, $event_meta, $venue_meta, $event_venue_join);
+			return $venue_SQL;
+		}
+		unset($VNU_ID, $event_meta, $event_venue_join);
+		return '';
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_venue_state($SQL = '')
+	{
+		// Venue Meta table name
+		$venue_meta_table = EEM_Venue::instance()->second_table();
+		// State table name
+		$state_table = EEM_State::instance()->table();
+		// State table pk
+		$state_table_pk = EEM_State::instance()->primary_key_name();
+		// verify vars
+		if ($venue_meta_table && $state_table && $state_table_pk) {
+			// like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
+			$join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
+			// don't add join if it has already been added
+			if (strpos($SQL, $join) === false) {
+				unset($state_table_pk, $venue_meta_table, $venue_table_pk);
+				return " LEFT JOIN $state_table ON ( $join )";
+			}
+		}
+		unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
+		return '';
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Show Expired ?
+			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
+			// Category
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
+			// Start Date
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param    boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		return ! $show_expired
+			? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+			: '';
+	}
+
+
+
+	/**
+	 * @param boolean $event_category_slug
+	 * @return string
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		global $wpdb;
+		if (! empty($event_category_slug)) {
+			$event_category_slugs_array = array_map('trim', explode(',', $event_category_slug));
+			$event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
+			return $wpdb->prepare(" AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ", $event_category_slugs_array);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @param boolean $month
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		$SQL = '';
+		if (! empty($month)) {
+			$datetime_table = EEM_Datetime::instance()->table();
+			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
+			$SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
+			$SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
+			$SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
+			$SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			$SQL = EEH_Event_Query::posts_orderby_sql(
+				EEH_Event_Query::$_event_query_orderby,
+				EEH_Event_Query::$_event_query_sort
+			);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 *    posts_orderby_sql
+	 *    possible parameters:
+	 *    ID
+	 *    start_date
+	 *    end_date
+	 *    event_name
+	 *    category_slug
+	 *    ticket_start
+	 *    ticket_end
+	 *    venue_title
+	 *    city
+	 *    state
+	 *    **IMPORTANT**
+	 *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
+	 *    or else some of the table references below will result in MySQL errors
+	 *
+	 * @param array  $orderby_params
+	 * @param string $sort
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby_sql(array $orderby_params = array(), $sort = 'ASC')
+	{
+		global $wpdb;
+		$SQL     = '';
+		$counter = 0;
+		$sort    = in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
+			? strtoupper($sort)
+			: 'ASC';
+		// make sure 'orderby' is set in query params
+		if (! isset(self::$_query_params['orderby'])) {
+			self::$_query_params['orderby'] = array();
+		}
+		// loop thru $orderby_params (type cast as array)
+		foreach ($orderby_params as $orderby) {
+			// check if we have already added this param
+			if (isset(self::$_query_params['orderby'][ $orderby ])) {
+				// if so then remove from the $orderby_params so that the count() method below is accurate
+				unset($orderby_params[ $orderby ]);
+				// then bump ahead to the next param
+				continue;
+			}
+			// this will ad a comma depending on whether this is the first or last param
+			$glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
+			// ok what's we dealing with?
+			switch ($orderby) {
+				case 'id':
+				case 'ID':
+					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					break;
+				case 'end_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					break;
+				case 'event_name':
+					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					break;
+				case 'category_slug':
+					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					break;
+				case 'ticket_start':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					break;
+				case 'ticket_end':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					break;
+				case 'venue_title':
+					$SQL .= $glue . 'venue_title ' . $sort;
+					break;
+				case 'city':
+					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					break;
+				case 'state':
+					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					break;
+				case 'start_date':
+				default:
+					$SQL .= $glue . ' event_start_date ' . $sort;
+					break;
+			}
+			// add to array of orderby params that have been added
+			self::$_query_params['orderby'][ $orderby ] = true;
+			$counter++;
+		}
+		return $SQL;
+	}
 }

Spacing +38 added lines, -38 removed lines

@@ -227,7 +227,7 @@ 
     {
         if (EEH_Event_Query::apply_query_filters($wp_query)) {
             global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
+            $clauses['groupby'] = $wpdb->posts.'.ID ';
         }
         return $clauses;
     }
@@ -264,23 +264,23 @@ 
      */
     public static function posts_fields_sql_for_orderby(array $orderby_params = array())
     {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+        $SQL = ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
         foreach ($orderby_params as $orderby) {
             switch ($orderby) {
                 case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_start_date';
                     break;
                 case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_end_date';
                     break;
                 case 'venue_title':
                     $SQL .= ', Venue.post_title AS venue_title';
                     break;
                 case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+                    $SQL .= ', '.EEM_Venue::instance()->second_table().'.VNU_city';
                     break;
                 case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+                    $SQL .= ', '.EEM_State::instance()->table().'.STA_name';
                     break;
             }
         }
@@ -322,12 +322,12 @@ 
      */
     public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
     {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! $show_expired) {
+            $join = EEM_Event::instance()->table().'.ID = ';
+            $join .= EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             // don't add if this is already in the SQL
             if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+                $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' ) ';
             }
         }
         return $SQL;
@@ -343,7 +343,7 @@ 
      */
     public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
     {
-        if (! empty($join_terms)) {
+        if ( ! empty($join_terms)) {
             global $wpdb;
             $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
             $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -373,13 +373,13 @@ 
                 case 'ticket_end':
                     $SQL .= EEH_Event_Query::_posts_join_for_datetime(
                         $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+                        EEM_Datetime_Ticket::instance()->table().'.'.EEM_Datetime::instance()->primary_key_name()
                     );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+                    $SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table();
                     $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Datetime_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' )';
                     break;
                 case 'venue_title':
@@ -392,7 +392,7 @@ 
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table().'.ID');
                     break;
             }
         }
@@ -412,10 +412,10 @@ 
      */
     protected static function _posts_join_for_datetime($SQL = '', $join = '')
     {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! empty($join)) {
+            $join .= ' = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+                return ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' )';
             }
         }
         return '';
@@ -527,7 +527,7 @@ 
     public static function posts_where_sql_for_show_expired($show_expired = false)
     {
         return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+            ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > \''.current_time('mysql', true).'\' '
             : '';
     }
 
@@ -540,7 +540,7 @@ 
     public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
     {
         global $wpdb;
-        if (! empty($event_category_slug)) {
+        if ( ! empty($event_category_slug)) {
             $event_category_slugs_array = array_map('trim', explode(',', $event_category_slug));
             $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
             return $wpdb->prepare(" AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ", $event_category_slugs_array);
@@ -561,14 +561,14 @@ 
     public static function posts_where_sql_for_event_list_month($month = null)
     {
         $SQL = '';
-        if (! empty($month)) {
+        if ( ! empty($month)) {
             $datetime_table = EEM_Datetime::instance()->table();
             // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
             $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month))."'";
             // event end date is GREATER than the start of the month ( so nothing that ended before this month )
             $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month))."' ";
         }
         return $SQL;
     }
@@ -631,15 +631,15 @@ 
             ? strtoupper($sort)
             : 'ASC';
         // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
+        if ( ! isset(self::$_query_params['orderby'])) {
             self::$_query_params['orderby'] = array();
         }
         // loop thru $orderby_params (type cast as array)
         foreach ($orderby_params as $orderby) {
             // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
+            if (isset(self::$_query_params['orderby'][$orderby])) {
                 // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
+                unset($orderby_params[$orderby]);
                 // then bump ahead to the next param
                 continue;
             }
@@ -649,39 +649,39 @@ 
             switch ($orderby) {
                 case 'id':
                 case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.ID '.$sort;
                     break;
                 case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
                     break;
                 case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
                     break;
                 case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+                    $SQL .= $glue.$wpdb->terms.'.slug '.$sort;
                     break;
                 case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
                     break;
                 case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
                     break;
                 case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
+                    $SQL .= $glue.'venue_title '.$sort;
                     break;
                 case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+                    $SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
                     break;
                 case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+                    $SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
+                    $SQL .= $glue.' event_start_date '.$sort;
                     break;
             }
             // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
+            self::$_query_params['orderby'][$orderby] = true;
             $counter++;
         }
         return $SQL;

core/db_models/EEM_Venue.model.php

Indentation +182 added lines, -182 removed lines

@@ -11,189 +11,189 @@
 class EEM_Venue extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Venue', 'event_espresso');
-        $this->plural_item = __('Venues', 'event_espresso');
-        $this->_tables = array(
-            'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
-        );
-        $this->_fields = array(
-            'Venue_CPT'  => array(
-                'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', __("Venue ID", "event_espresso")),
-                'VNU_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    __("Venue Name", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    __("Venue Description", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_identifier' => new EE_Slug_Field('post_name', __("Venue Identifier", "event_espresso"), false, ''),
-                'VNU_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    __("Date Venue Created", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_short_desc' => new EE_Plain_Text_Field(
-                    'post_excerpt',
-                    __("Short Description of Venue", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    __("Venue Modified Date", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    __("Venue Creator ID", "event_espresso"),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    __("Venue Parent ID", "event_espresso"),
-                    false,
-                    0
-                ),
-                'VNU_order'      => new EE_Integer_Field('menu_order', __("Venue order", "event_espresso"), false, 1),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
-                'password' => new EE_Password_Field(
-                    'post_password',
-                    __('Password', 'event_espresso'),
-                    false,
-                    '',
-                    array(
-                        'VNU_desc',
-                        'VNU_short_desc',
-                        'VNU_address',
-                        'VNU_address2',
-                        'VNU_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'VNU_zip',
-                        'VNU_phone',
-                        'VNU_capacity',
-                        'VNU_url',
-                        'VNU_virtual_phone',
-                        'VNU_virtual_url',
-                        'VNU_google_map_link',
-                        'VNU_enable_for_gmap',
-                    )
-                )
-            ),
-            'Venue_Meta' => array(
-                'VNUM_ID'             => new EE_DB_Only_Int_Field(
-                    'VNUM_ID',
-                    __("ID of Venue Meta Row", "event_espresso"),
-                    false
-                ),
-                'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
-                    'VNU_ID',
-                    __("Foreign Key to Venue Post ", "event_espresso"),
-                    false
-                ),
-                'VNU_address'         => new EE_Plain_Text_Field(
-                    'VNU_address',
-                    __("Venue Address line 1", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_address2'        => new EE_Plain_Text_Field(
-                    'VNU_address2',
-                    __("Venue Address line 2", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_city'            => new EE_Plain_Text_Field(
-                    'VNU_city',
-                    __("Venue City", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'STA_ID'              => new EE_Foreign_Key_Int_Field(
-                    'STA_ID',
-                    __("State ID", "event_espresso"),
-                    true,
-                    null,
-                    'State'
-                ),
-                'CNT_ISO'             => new EE_Foreign_Key_String_Field(
-                    'CNT_ISO',
-                    __("Country Code", "event_espresso"),
-                    true,
-                    null,
-                    'Country'
-                ),
-                'VNU_zip'             => new EE_Plain_Text_Field(
-                    'VNU_zip',
-                    __("Venue Zip/Postal Code", "event_espresso"),
-                    true
-                ),
-                'VNU_phone'           => new EE_Plain_Text_Field(
-                    'VNU_phone',
-                    __("Venue Phone", "event_espresso"),
-                    true
-                ),
-                'VNU_capacity'        => new EE_Infinite_Integer_Field(
-                    'VNU_capacity',
-                    __("Venue Capacity", "event_espresso"),
-                    true,
-                    EE_INF
-                ),
-                'VNU_url'             => new EE_Plain_Text_Field(
-                    'VNU_url',
-                    __('Venue Website', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_phone'   => new EE_Plain_Text_Field(
-                    'VNU_virtual_phone',
-                    __('Call in Number', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_url'     => new EE_Plain_Text_Field(
-                    'VNU_virtual_url',
-                    __('Virtual URL', 'event_espresso'),
-                    true
-                ),
-                'VNU_google_map_link' => new EE_Plain_Text_Field(
-                    'VNU_google_map_link',
-                    __('Google Map Link', 'event_espresso'),
-                    true
-                ),
-                'VNU_enable_for_gmap' => new EE_Boolean_Field(
-                    'VNU_enable_for_gmap',
-                    __('Show Google Map?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_Has_Many_Relation(),
-            'Datetime'          => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password = '';
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Venue', 'event_espresso');
+		$this->plural_item = __('Venues', 'event_espresso');
+		$this->_tables = array(
+			'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
+		);
+		$this->_fields = array(
+			'Venue_CPT'  => array(
+				'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', __("Venue ID", "event_espresso")),
+				'VNU_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					__("Venue Name", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					__("Venue Description", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_identifier' => new EE_Slug_Field('post_name', __("Venue Identifier", "event_espresso"), false, ''),
+				'VNU_created'    => new EE_Datetime_Field(
+					'post_date',
+					__("Date Venue Created", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_short_desc' => new EE_Plain_Text_Field(
+					'post_excerpt',
+					__("Short Description of Venue", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					__("Venue Modified Date", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					__("Venue Creator ID", "event_espresso"),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					__("Venue Parent ID", "event_espresso"),
+					false,
+					0
+				),
+				'VNU_order'      => new EE_Integer_Field('menu_order', __("Venue order", "event_espresso"), false, 1),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
+				'password' => new EE_Password_Field(
+					'post_password',
+					__('Password', 'event_espresso'),
+					false,
+					'',
+					array(
+						'VNU_desc',
+						'VNU_short_desc',
+						'VNU_address',
+						'VNU_address2',
+						'VNU_city',
+						'STA_ID',
+						'CNT_ISO',
+						'VNU_zip',
+						'VNU_phone',
+						'VNU_capacity',
+						'VNU_url',
+						'VNU_virtual_phone',
+						'VNU_virtual_url',
+						'VNU_google_map_link',
+						'VNU_enable_for_gmap',
+					)
+				)
+			),
+			'Venue_Meta' => array(
+				'VNUM_ID'             => new EE_DB_Only_Int_Field(
+					'VNUM_ID',
+					__("ID of Venue Meta Row", "event_espresso"),
+					false
+				),
+				'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
+					'VNU_ID',
+					__("Foreign Key to Venue Post ", "event_espresso"),
+					false
+				),
+				'VNU_address'         => new EE_Plain_Text_Field(
+					'VNU_address',
+					__("Venue Address line 1", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_address2'        => new EE_Plain_Text_Field(
+					'VNU_address2',
+					__("Venue Address line 2", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_city'            => new EE_Plain_Text_Field(
+					'VNU_city',
+					__("Venue City", "event_espresso"),
+					true,
+					''
+				),
+				'STA_ID'              => new EE_Foreign_Key_Int_Field(
+					'STA_ID',
+					__("State ID", "event_espresso"),
+					true,
+					null,
+					'State'
+				),
+				'CNT_ISO'             => new EE_Foreign_Key_String_Field(
+					'CNT_ISO',
+					__("Country Code", "event_espresso"),
+					true,
+					null,
+					'Country'
+				),
+				'VNU_zip'             => new EE_Plain_Text_Field(
+					'VNU_zip',
+					__("Venue Zip/Postal Code", "event_espresso"),
+					true
+				),
+				'VNU_phone'           => new EE_Plain_Text_Field(
+					'VNU_phone',
+					__("Venue Phone", "event_espresso"),
+					true
+				),
+				'VNU_capacity'        => new EE_Infinite_Integer_Field(
+					'VNU_capacity',
+					__("Venue Capacity", "event_espresso"),
+					true,
+					EE_INF
+				),
+				'VNU_url'             => new EE_Plain_Text_Field(
+					'VNU_url',
+					__('Venue Website', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_phone'   => new EE_Plain_Text_Field(
+					'VNU_virtual_phone',
+					__('Call in Number', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_url'     => new EE_Plain_Text_Field(
+					'VNU_virtual_url',
+					__('Virtual URL', 'event_espresso'),
+					true
+				),
+				'VNU_google_map_link' => new EE_Plain_Text_Field(
+					'VNU_google_map_link',
+					__('Google Map Link', 'event_espresso'),
+					true
+				),
+				'VNU_enable_for_gmap' => new EE_Boolean_Field(
+					'VNU_enable_for_gmap',
+					__('Show Google Map?', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_Has_Many_Relation(),
+			'Datetime'          => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password = '';
+		parent::__construct($timezone);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
             'WP_User'           => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password = '';
         parent::__construct($timezone);
     }

core/db_classes/EE_Event.class.php

Indentation +1481 added lines, -1481 removed lines

@@ -16,1485 +16,1485 @@
 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 int|EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_ID(array $query_params = array()): int
-    {
-        $venue = $this->get_first_related('Venue', $query_params);
-        return $venue instanceof EE_Venue ? $venue->ID() : 0;
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @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
-     * @throws ReflectionException
-     */
-    public function venue(array $query_params = array())
-    {
-        return $this->get_first_related('Venue', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated $VID:$
-     */
-    public function venues(array $query_params = array()): array
-    {
-        return (array) $this->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
-    {
-        if (! Cuid::isCuid($UUID)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                /* translators: 1: UUID value, 2: UUID generator function. */
-                    esc_html__(
-                        'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
-                        'event_espresso'
-                    ),
-                    $UUID,
-                    '`Cuid::cuid()`'
-                )
-            );
-        }
-        $this->set('FSC_UUID', $UUID);
-    }
+	/**
+	 * 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 int|EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_ID(array $query_params = array()): int
+	{
+		$venue = $this->get_first_related('Venue', $query_params);
+		return $venue instanceof EE_Venue ? $venue->ID() : 0;
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @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
+	 * @throws ReflectionException
+	 */
+	public function venue(array $query_params = array())
+	{
+		return $this->get_first_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated $VID:$
+	 */
+	public function venues(array $query_params = array()): array
+	{
+		return (array) $this->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
+	{
+		if (! Cuid::isCuid($UUID)) {
+			throw new InvalidArgumentException(
+				sprintf(
+				/* translators: 1: UUID value, 2: UUID generator function. */
+					esc_html__(
+						'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
+						'event_espresso'
+					),
+					$UUID,
+					'`Cuid::cuid()`'
+				)
+			);
+		}
+		$this->set('FSC_UUID', $UUID);
+	}
 }