eventespresso / event-espresso-core

core/CPTs/EE_CPT_Event_Strategy.core.php

Indentation +219 added lines, -219 removed lines

@@ -11,251 +11,251 @@
  */
 class EE_CPT_Event_Strategy
 {
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     */
-    protected array $CPT;
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 */
+	protected array $CPT;
 
-    private string $current_time;
+	private string $current_time;
 
-    private string $datetime_table;
+	private string $datetime_table;
 
-    private string $event_table;
+	private string $event_table;
 
-    private string $event_table_pk;
+	private string $event_table_pk;
 
-    public EE_Template_Config $template_settings;
+	public EE_Template_Config $template_settings;
 
 
-    /**
-     * @param WP_Query           $wp_query
-     * @param array              $CPT
-     * @param EE_Template_Config $template_settings
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(WP_Query $wp_query, array $CPT, EE_Template_Config $template_settings)
-    {
-        $this->CPT = $CPT;
-        $this->current_time      = current_time('mysql', true);
-        $this->datetime_table    = EEM_Datetime::instance()->table();
-        $this->event_table       = EEM_Event::instance()->table();
-        $this->event_table_pk    = EEM_Event::instance()->primary_key_name();
-        $this->template_settings = $template_settings;
+	/**
+	 * @param WP_Query           $wp_query
+	 * @param array              $CPT
+	 * @param EE_Template_Config $template_settings
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(WP_Query $wp_query, array $CPT, EE_Template_Config $template_settings)
+	{
+		$this->CPT = $CPT;
+		$this->current_time      = current_time('mysql', true);
+		$this->datetime_table    = EEM_Datetime::instance()->table();
+		$this->event_table       = EEM_Event::instance()->table();
+		$this->event_table_pk    = EEM_Event::instance()->primary_key_name();
+		$this->template_settings = $template_settings;
 
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where'
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        $this->_add_filters();
-        $wp_query->is_espresso_event_single   = is_singular()
-            && (
-                (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::EVENTS)
-                || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::EVENTS)
-            );
-        $wp_query->is_espresso_event_archive  = is_post_type_archive(EspressoPostType::EVENTS);
-        $wp_query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
-    }
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where'
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		$this->_add_filters();
+		$wp_query->is_espresso_event_single   = is_singular()
+			&& (
+				(isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::EVENTS)
+				|| (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::EVENTS)
+			);
+		$wp_query->is_espresso_event_archive  = is_post_type_archive(EspressoPostType::EVENTS);
+		$wp_query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
+	}
 
 
-    /**
-     * When an instance of this class is created, we add our filters
-     * (which will get removed in case the next call to get_posts ISN'T
-     * for event CPTs)
-     */
-    protected function _add_filters()
-    {
-        add_filter('posts_fields', [$this, 'posts_fields'], 1, 2);
-        add_filter('posts_join', [$this, 'posts_join'], 1, 2);
-        add_filter('posts_where', [$this, 'posts_where'], 10, 2);
-        // add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
-        add_filter('posts_orderby', [$this, 'posts_orderby'], 1, 2);
-        add_filter('posts_groupby', [$this, 'posts_groupby'], 1, 2);
-        add_action('the_post', [$this, 'the_post'], 1);
-    }
+	/**
+	 * When an instance of this class is created, we add our filters
+	 * (which will get removed in case the next call to get_posts ISN'T
+	 * for event CPTs)
+	 */
+	protected function _add_filters()
+	{
+		add_filter('posts_fields', [$this, 'posts_fields'], 1, 2);
+		add_filter('posts_join', [$this, 'posts_join'], 1, 2);
+		add_filter('posts_where', [$this, 'posts_where'], 10, 2);
+		// add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
+		add_filter('posts_orderby', [$this, 'posts_orderby'], 1, 2);
+		add_filter('posts_groupby', [$this, 'posts_groupby'], 1, 2);
+		add_action('the_post', [$this, 'the_post'], 1);
+	}
 
 
-    /**
-     * public access to _remove_filters()
-     *
-     * @since 4.9.63.p
-     */
-    public function remove_filters()
-    {
-    }
+	/**
+	 * public access to _remove_filters()
+	 *
+	 * @since 4.9.63.p
+	 */
+	public function remove_filters()
+	{
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return    string
-     * @noinspection PhpUndefinedFieldInspection
-     */
-    public function posts_fields(string $SQL, WP_Query $wp_query): string
-    {
-        if (
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-            && $this->isEspressoEvent($wp_query)
-            && strpos($SQL, $this->datetime_table) === false
-        ) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ", $this->datetime_table.* ";
-            if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
-                // because we only want to retrieve the next upcoming datetime for each event:
-                // add something like:
-                // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
-                // to WP Query SELECT statement
-                $SQL .= ", MIN( $this->datetime_table.DTT_EVT_start ) as event_start_date ";
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return    string
+	 * @noinspection PhpUndefinedFieldInspection
+	 */
+	public function posts_fields(string $SQL, WP_Query $wp_query): string
+	{
+		if (
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+			&& $this->isEspressoEvent($wp_query)
+			&& strpos($SQL, $this->datetime_table) === false
+		) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= ", $this->datetime_table.* ";
+			if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
+				// because we only want to retrieve the next upcoming datetime for each event:
+				// add something like:
+				// ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
+				// to WP Query SELECT statement
+				$SQL .= ", MIN( $this->datetime_table.DTT_EVT_start ) as event_start_date ";
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @noinspection PhpUndefinedFieldInspection
-     */
-    public function posts_join(string $SQL, WP_Query $wp_query): string
-    {
-        if (
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-            && $this->isEspressoEvent($wp_query)
-            && strpos($SQL, $this->datetime_table) === false
-        ) {
-            // adds something like:
-            // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
-            // to WP Query JOIN statement
-            $SQL .= " INNER JOIN $this->datetime_table";
-            $SQL .= " ON ( $this->event_table.ID = $this->datetime_table.$this->event_table_pk ) ";
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @noinspection PhpUndefinedFieldInspection
+	 */
+	public function posts_join(string $SQL, WP_Query $wp_query): string
+	{
+		if (
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+			&& $this->isEspressoEvent($wp_query)
+			&& strpos($SQL, $this->datetime_table) === false
+		) {
+			// adds something like:
+			// " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
+			// to WP Query JOIN statement
+			$SQL .= " INNER JOIN $this->datetime_table";
+			$SQL .= " ON ( $this->event_table.ID = $this->datetime_table.$this->event_table_pk ) ";
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @noinspection PhpUndefinedFieldInspection
-     */
-    public function posts_where(string $SQL, WP_Query $wp_query): string
-    {
-        if (
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-            && $this->isEspressoEvent($wp_query)
-            && strpos($SQL, $this->datetime_table) === false
-        ) {
-            if (
-                ! isset($this->template_settings->EED_Events_Archive)
-                || ! isset($this->template_settings->EED_Events_Archive->display_expired_events)
-                || ! $this->template_settings->EED_Events_Archive->display_expired_events
-            ) {
-                $SQL .= " AND $this->datetime_table.DTT_EVT_end > '$this->current_time' ";
-            }
-            // exclude trashed datetimes
-            $SQL .= " AND $this->datetime_table.DTT_deleted = 0";
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @noinspection PhpUndefinedFieldInspection
+	 */
+	public function posts_where(string $SQL, WP_Query $wp_query): string
+	{
+		if (
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+			&& $this->isEspressoEvent($wp_query)
+			&& strpos($SQL, $this->datetime_table) === false
+		) {
+			if (
+				! isset($this->template_settings->EED_Events_Archive)
+				|| ! isset($this->template_settings->EED_Events_Archive->display_expired_events)
+				|| ! $this->template_settings->EED_Events_Archive->display_expired_events
+			) {
+				$SQL .= " AND $this->datetime_table.DTT_EVT_end > '$this->current_time' ";
+			}
+			// exclude trashed datetimes
+			$SQL .= " AND $this->datetime_table.DTT_deleted = 0";
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @noinspection PhpUndefinedFieldInspection
-     */
-    public function posts_orderby(string $SQL, WP_Query $wp_query): string
-    {
-        if (
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-            && $this->isEspressoEvent($wp_query)
-            && strpos($SQL, 'event_start_date') === false
-        ) {
-            $SQL = ' event_start_date ASC ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @noinspection PhpUndefinedFieldInspection
+	 */
+	public function posts_orderby(string $SQL, WP_Query $wp_query): string
+	{
+		if (
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+			&& $this->isEspressoEvent($wp_query)
+			&& strpos($SQL, 'event_start_date') === false
+		) {
+			$SQL = ' event_start_date ASC ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @noinspection PhpUndefinedFieldInspection
-     */
-    public function posts_groupby(string $SQL, WP_Query $wp_query): string
-    {
-        global $wpdb;
-        if (
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-            && $this->isEspressoEvent($wp_query)
-            && strpos($SQL, "$wpdb->posts.ID") === false
-        ) {
-            // TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
-            // we're joining to the datetimes table, where there can be MANY datetimes for a single event,
-            // but we want to only show each event only once
-            // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
-            $SQL = "$wpdb->posts.ID ";
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @noinspection PhpUndefinedFieldInspection
+	 */
+	public function posts_groupby(string $SQL, WP_Query $wp_query): string
+	{
+		global $wpdb;
+		if (
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+			&& $this->isEspressoEvent($wp_query)
+			&& strpos($SQL, "$wpdb->posts.ID") === false
+		) {
+			// TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
+			// we're joining to the datetimes table, where there can be MANY datetimes for a single event,
+			// but we want to only show each event only once
+			// (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
+			$SQL = "$wpdb->posts.ID ";
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts(array $posts, WP_Query $wp_query): array
-    {
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts(array $posts, WP_Query $wp_query): array
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param WP_Post $post The Post object (passed by reference).
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function the_post(WP_Post &$post)
-    {
-        if ($post->post_type === EspressoPostType::EVENTS && ! isset($post->EE_Event)) {
-            $post->EE_Event = EEM_Event::instance()->get_one_by_ID($post->ID);
-        }
-    }
+	/**
+	 * @param WP_Post $post The Post object (passed by reference).
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function the_post(WP_Post &$post)
+	{
+		if ($post->post_type === EspressoPostType::EVENTS && ! isset($post->EE_Event)) {
+			$post->EE_Event = EEM_Event::instance()->get_one_by_ID($post->ID);
+		}
+	}
 
 
-    private function isEspressoEvent(WP_Query $wp_query): bool
-    {
-        return EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) === EspressoPostType::EVENTS;
-    }
+	private function isEspressoEvent(WP_Query $wp_query): bool
+	{
+		return EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) === EspressoPostType::EVENTS;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
         // 'posts_fields'
         // 'posts_join'
         $this->_add_filters();
-        $wp_query->is_espresso_event_single   = is_singular()
+        $wp_query->is_espresso_event_single = is_singular()
             && (
                 (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::EVENTS)
                 || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::EVENTS)
@@ -246,7 +246,7 @@ 
      * @throws EE_Error
      * @throws ReflectionException
      */
-    public function the_post(WP_Post &$post)
+    public function the_post(WP_Post & $post)
     {
         if ($post->post_type === EspressoPostType::EVENTS && ! isset($post->EE_Event)) {
             $post->EE_Event = EEM_Event::instance()->get_one_by_ID($post->ID);

core/CPTs/EE_CPT_Venue_Strategy.core.php

Indentation +42 added lines, -42 removed lines

@@ -11,50 +11,50 @@
  */
 class EE_CPT_Venue_Strategy
 {
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     */
-    protected array $CPT;
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 */
+	protected array $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct(WP_Query $wp_query, array $CPT = [])
-    {
-        $this->CPT = $CPT;
-        if (! $wp_query->is_tag) {
-            $wp_query->is_espresso_venue_single   = is_singular()
-                && (
-                    (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::VENUES)
-                    || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::VENUES)
-                );
-            $wp_query->is_espresso_venue_archive  = is_post_type_archive(EspressoPostType::VENUES);
-            $wp_query->is_espresso_venue_taxonomy = is_tax('espresso_venue_categories');
-        }
-        add_filter('the_posts', [$this, 'the_posts'], 1, 2);
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct(WP_Query $wp_query, array $CPT = [])
+	{
+		$this->CPT = $CPT;
+		if (! $wp_query->is_tag) {
+			$wp_query->is_espresso_venue_single   = is_singular()
+				&& (
+					(isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::VENUES)
+					|| (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::VENUES)
+				);
+			$wp_query->is_espresso_venue_archive  = is_post_type_archive(EspressoPostType::VENUES);
+			$wp_query->is_espresso_venue_taxonomy = is_tax('espresso_venue_categories');
+		}
+		add_filter('the_posts', [$this, 'the_posts'], 1, 2);
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts(array $posts, WP_Query $wp_query): array
-    {
-        if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== EspressoPostType::VENUES) {
-            return $posts;
-        }
-        // automagically load the EEH_Venue_View helper so that it's functions are available
-        if (
-            isset(EE_Registry::instance()->CFG->map_settings->use_google_maps)
-            && EE_Registry::instance()->CFG->map_settings->use_google_maps
-        ) {
-            EEH_Maps::espresso_google_map_js();
-        }
-        remove_filter('the_posts', [$this, 'the_posts'], 1);
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts(array $posts, WP_Query $wp_query): array
+	{
+		if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== EspressoPostType::VENUES) {
+			return $posts;
+		}
+		// automagically load the EEH_Venue_View helper so that it's functions are available
+		if (
+			isset(EE_Registry::instance()->CFG->map_settings->use_google_maps)
+			&& EE_Registry::instance()->CFG->map_settings->use_google_maps
+		) {
+			EEH_Maps::espresso_google_map_js();
+		}
+		remove_filter('the_posts', [$this, 'the_posts'], 1);
+		return $posts;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -24,8 +24,8 @@
     public function __construct(WP_Query $wp_query, array $CPT = [])
     {
         $this->CPT = $CPT;
-        if (! $wp_query->is_tag) {
-            $wp_query->is_espresso_venue_single   = is_singular()
+        if ( ! $wp_query->is_tag) {
+            $wp_query->is_espresso_venue_single = is_singular()
                 && (
                     (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::VENUES)
                     || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::VENUES)

core/CPTs/CptQueryModifier.php

Indentation +474 added lines, -474 removed lines

@@ -31,495 +31,495 @@
  */
 class CptQueryModifier
 {
-    protected CurrentPage $current_page;
+	protected CurrentPage $current_page;
 
-    protected LoaderInterface $loader;
-
-    protected RequestInterface $request;
-
-    protected WP_Query $wp_query;
-
-    protected ?EEM_CPT_Base $model = null;
+	protected LoaderInterface $loader;
+
+	protected RequestInterface $request;
+
+	protected WP_Query $wp_query;
+
+	protected ?EEM_CPT_Base $model = null;
 
-    /**
-     * meta table for the related CPT
-     */
-    protected ?EE_Secondary_Table $meta_table = null;
-
-    protected ?EE_Request_Handler $request_handler = null;
-
-    protected string $post_type = '';
+	/**
+	 * meta table for the related CPT
+	 */
+	protected ?EE_Secondary_Table $meta_table = null;
+
+	protected ?EE_Request_Handler $request_handler = null;
+
+	protected string $post_type = '';
 
-    /**
-     * @var EE_CPT_Attendee_Strategy|EE_CPT_Default_Strategy|EE_CPT_Event_Strategy|EE_CPT_Venue_Strategy|null
-     */
-    protected $cpt_strategy = null;
-
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     *
-     * @var array $cpt_details
-     */
-    protected array $cpt_details = [];
+	/**
+	 * @var EE_CPT_Attendee_Strategy|EE_CPT_Default_Strategy|EE_CPT_Event_Strategy|EE_CPT_Venue_Strategy|null
+	 */
+	protected $cpt_strategy = null;
+
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 *
+	 * @var array $cpt_details
+	 */
+	protected array $cpt_details = [];
 
-    /**
-     * @var EE_Table_Base[] $model_tables
-     */
-    protected array $model_tables = [];
+	/**
+	 * @var EE_Table_Base[] $model_tables
+	 */
+	protected array $model_tables = [];
 
-    protected array $taxonomies = [];
+	protected array $taxonomies = [];
 
 
-    /**
-     * CptQueryModifier constructor
-     *
-     * @param string           $post_type
-     * @param array            $cpt_details
-     * @param WP_Query         $wp_query
-     * @param CurrentPage      $current_page
-     * @param RequestInterface $request
-     * @param LoaderInterface  $loader
-     * @throws EE_Error
-     */
-    public function __construct(
-        string $post_type,
-        array $cpt_details,
-        WP_Query $wp_query,
-        CurrentPage $current_page,
-        RequestInterface $request,
-        LoaderInterface $loader
-    ) {
-        $this->loader       = $loader;
-        $this->request      = $request;
-        $this->current_page = $current_page;
-        $this->setWpQuery($wp_query);
-        $this->setPostType($post_type);
-        $this->setCptDetails($cpt_details);
-        $this->init();
-    }
+	/**
+	 * CptQueryModifier constructor
+	 *
+	 * @param string           $post_type
+	 * @param array            $cpt_details
+	 * @param WP_Query         $wp_query
+	 * @param CurrentPage      $current_page
+	 * @param RequestInterface $request
+	 * @param LoaderInterface  $loader
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		string $post_type,
+		array $cpt_details,
+		WP_Query $wp_query,
+		CurrentPage $current_page,
+		RequestInterface $request,
+		LoaderInterface $loader
+	) {
+		$this->loader       = $loader;
+		$this->request      = $request;
+		$this->current_page = $current_page;
+		$this->setWpQuery($wp_query);
+		$this->setPostType($post_type);
+		$this->setCptDetails($cpt_details);
+		$this->init();
+	}
 
 
-    public function postType(): string
-    {
-        return $this->post_type;
-    }
+	public function postType(): string
+	{
+		return $this->post_type;
+	}
 
 
-    protected function setPostType(string $post_type)
-    {
-        $this->post_type = $post_type;
-    }
+	protected function setPostType(string $post_type)
+	{
+		$this->post_type = $post_type;
+	}
 
 
-    public function cptDetails(): array
-    {
-        return $this->cpt_details;
-    }
+	public function cptDetails(): array
+	{
+		return $this->cpt_details;
+	}
 
 
-    protected function setCptDetails(array $cpt_details)
-    {
-        $this->cpt_details = $cpt_details;
-    }
+	protected function setCptDetails(array $cpt_details)
+	{
+		$this->cpt_details = $cpt_details;
+	}
 
 
-    /**
-     * @return EE_Table_Base[]
-     */
-    public function modelTables(): array
-    {
-        return $this->model_tables;
-    }
-
-
-    /**
-     * @param EE_Table_Base[] $model_tables
-     */
-    protected function setModelTables(array $model_tables)
-    {
-        $this->model_tables = $model_tables;
-    }
-
-
-    public function taxonomies(): array
-    {
-        if (empty($this->taxonomies)) {
-            $this->initializeTaxonomies();
-        }
-        return $this->taxonomies;
-    }
-
-
-    protected function setTaxonomies(array $taxonomies)
-    {
-        $this->taxonomies = $taxonomies;
-    }
-
-
-    public function metaTable(): ?EE_Secondary_Table
-    {
-        return $this->meta_table;
-    }
-
-
-    public function setMetaTable(EE_Secondary_Table $meta_table)
-    {
-        $this->meta_table = $meta_table;
-    }
-
-
-    public function model(): ?EEM_CPT_Base
-    {
-        return $this->model;
-    }
-
-
-    protected function setModel(EEM_CPT_Base $CPT_model)
-    {
-        $this->model = $CPT_model;
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     * @deprecated 4.9.63.p
-     */
-    public function request(): ?EE_Request_Handler
-    {
-        if (! $this->request_handler instanceof EE_Request_Handler) {
-            $this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->request_handler;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    public function WpQuery(): WP_Query
-    {
-        return $this->wp_query;
-    }
-
-
-    // phpcs:enable
-
-
-    public function setWpQuery(WP_Query $wp_query)
-    {
-        $this->wp_query = $wp_query;
-    }
-
-
-    protected function initializeTaxonomies()
-    {
-        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
-        if (
-            empty($this->taxonomies)
-            && isset($this->cpt_details['args']['taxonomies'])
-        ) {
-            // if so then grab them, but we want the taxonomy name as the key
-            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
-            // then grab the list of ALL taxonomies
-            /** @var CustomTaxonomyDefinitions $taxonomy_definitions */
-            $taxonomy_definitions = $this->loader->getShared(CustomTaxonomyDefinitions::class);
-            $all_taxonomies       = $taxonomy_definitions->getCustomTaxonomyDefinitions();
-            foreach ($taxonomies as $taxonomy => &$details) {
-                // add details to our taxonomies if they exist
-                $details = $all_taxonomies[ $taxonomy ] ?? [];
-            }
-            // ALWAYS unset() variables that were passed by reference
-            unset($details);
-            $this->setTaxonomies($taxonomies);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.9.63.p
-     */
-    protected function init()
-    {
-        $this->setAdditionalCptDetails();
-        $this->setRequestVarsIfCpt();
-        // convert post_type to model name
-        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
-        // load all tables related to CPT
-        $this->setupModelsAndTables($model_name);
-        // load and instantiate CPT_*_Strategy
-        $this->cpt_strategy = $this->cpt_strategy === null
-            ? $this->cptStrategyClass($model_name)
-            : $this->cpt_strategy;
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        add_filter('posts_fields', [$this, 'postsFields'], 10, 2);
-        add_filter('posts_join', [$this, 'postsJoin'], 10, 2);
-        add_filter('the_posts', [$this, 'thePosts'], 1, 2);
-        if ($this->wp_query->is_main_query()) {
-            add_filter('get_edit_post_link', [$this, 'getEditPostLink'], 10, 2);
-            $this->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * sets some basic query vars that pertain to the CPT
-     *
-     * @return void
-     */
-    protected function setAdditionalCptDetails()
-    {
-        // the post or category or term that is triggering EE
-        $this->cpt_details['espresso_page'] = $this->current_page->isEspressoPage();
-        // requested post name
-        $this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
-        // add support for viewing 'private', 'draft', or 'pending' posts
-        if (
-            isset($this->wp_query->query_vars['p'])
-            && $this->wp_query->query_vars['p'] !== 0
-            && is_user_logged_in()
-            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
-        ) {
-            // we can just inject directly into the WP_Query object
-            $this->wp_query->query['post_status'] = ['publish', 'private', 'draft', 'pending'];
-            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
-            $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-        }
-    }
-
-
-    /**
-     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
-     * If so, sets the 'ee' request variable
-     * so other parts of EE can know what CPT is getting queried.
-     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
-     * in order for is_archive() and is_single() methods to work properly.
-     *
-     * @return void
-     */
-    public function setRequestVarsIfCpt()
-    {
-        // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
-            // check that route exists for CPT archive slug
-            if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
-                // ie: set "ee" to "events"
-                $this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
-                // or does it match a single page CPT like /event/
-            } elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
-                // ie: set "ee" to "event"
-                $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-            }
-        }
-    }
-
-
-    /**
-     * setupModelsAndTables
-     *
-     * @param string $model_name
-     * @throws EE_Error
-     */
-    protected function setupModelsAndTables(string $model_name)
-    {
-        // get CPT table data via CPT Model
-        $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
-            : $model_name;
-        $model           = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_CPT_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" model could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $full_model_name
-                )
-            );
-        }
-        $this->setModel($model);
-        $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
-        // is there a Meta Table for this CPT?
-        if (
-            isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
-        ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
-        }
-    }
-
-
-    /**
-     * cptStrategyClass
-     *
-     * @param string $model_name
-     * @return EE_CPT_Event_Strategy|EE_CPT_Attendee_Strategy|EE_CPT_Default_Strategy|EE_CPT_Venue_Strategy
-     */
-    protected function cptStrategyClass(string $model_name)
-    {
-        // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
-        // load and instantiate
-        $CPT_Strategy = $this->loader->getShared($CPT_Strategy_class_name, [$this->wp_query, $this->cpt_details]);
-        if ($CPT_Strategy === null) {
-            $CPT_Strategy = $this->loader->getShared('EE_CPT_Default_Strategy', [$this->wp_query, $this->cpt_details]);
-        }
-        return $CPT_Strategy;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function postsFields(string $SQL, WP_Query $wp_query): string
-    {
-        if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
-            return $SQL;
-        }
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
-        }
-        remove_filter('posts_fields', [$this, 'postsFields']);
-        return $SQL;
-    }
-
-
-    /**
-     * @param string $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function postsJoin(string $SQL, WP_Query $wp_query): string
-    {
-        if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
-            return $SQL;
-        }
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            global $wpdb;
-            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
-            $posts_table = $wpdb->posts;
-            $meta_table = $this->meta_table->get_table_name();
-            $foreign_key = $this->meta_table->get_fk_on_table();
-            $SQL .= " LEFT JOIN $meta_table ON ( $meta_table.$foreign_key = $posts_table.ID ) ";
-        }
-        remove_filter('posts_join', [$this, 'postsJoin']);
-        return $SQL;
-    }
-
-
-    /**
-     * thePosts
-     *
-     * @param WP_Post[] $posts
-     * @param WP_Query  $wp_query
-     * @return WP_Post[]
-     */
-    public function thePosts(array $posts, WP_Query $wp_query): array
-    {
-        if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
-            return $posts;
-        }
-        $CPT_class = $this->cpt_details['class_name'];
-        // loop thru posts
-        if ($this->model instanceof EEM_CPT_Base) {
-            foreach ($posts as $post) {
-                if ($post->post_type === $this->post_type) {
-                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
-                }
-            }
-        }
-        remove_filter('the_posts', [$this, 'thePosts'], 1);
-        return $posts;
-    }
-
-
-    /**
-     * @param string|null $url
-     * @param int    $ID
-     * @return null|string
-     */
-    public function getEditPostLink(?string $url, int $ID): ?string
-    {
-        // need to make sure we only edit links if our cpt
-        global $post;
-        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
-        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (
-            ! $post instanceof WP_Post
-            || $post->post_type !== $this->post_type
-            || (
-                isset($this->cpt_details['args']['show_ee_ui'])
-                && ! $this->cpt_details['args']['show_ee_ui']
-            )
-        ) {
-            return $url;
-        }
-        // k made it here so all is good.
-        return wp_nonce_url(
-            add_query_arg(
-                ['page' => $this->post_type, 'post' => $ID, 'action' => 'edit'],
-                admin_url('admin.php')
-            ),
-            'edit',
-            'edit_nonce'
-        );
-    }
-
-
-    /**
-     * Execute any template filters.
-     * This method is only called if in main query.
-     *
-     * @return void
-     */
-    public function addTemplateFilters()
-    {
-        // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
-            // then let's hook into the appropriate query_template hook
-            add_filter('single_template', [$this, 'singleCptTemplate']);
-        }
-    }
-
-
-    /**
-     * Callback for single_template wp filter.
-     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
-     * hierarchy.
-     *
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function singleCptTemplate(string $current_template): string
-    {
-        $object = get_queried_object();
-        // does this called object HAVE a page template set that is something other than the default.
-        $template = get_post_meta($object->ID, '_wp_page_template', true);
-        // exit early if default or not set or invalid path (accounts for theme changes)
-        if (
-            $template === 'default'
-            || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
-        ) {
-            return $current_template;
-        }
-        // made it here so we SHOULD be able to just locate the template and then return it.
-        return locate_template([$template]);
-    }
+	/**
+	 * @return EE_Table_Base[]
+	 */
+	public function modelTables(): array
+	{
+		return $this->model_tables;
+	}
+
+
+	/**
+	 * @param EE_Table_Base[] $model_tables
+	 */
+	protected function setModelTables(array $model_tables)
+	{
+		$this->model_tables = $model_tables;
+	}
+
+
+	public function taxonomies(): array
+	{
+		if (empty($this->taxonomies)) {
+			$this->initializeTaxonomies();
+		}
+		return $this->taxonomies;
+	}
+
+
+	protected function setTaxonomies(array $taxonomies)
+	{
+		$this->taxonomies = $taxonomies;
+	}
+
+
+	public function metaTable(): ?EE_Secondary_Table
+	{
+		return $this->meta_table;
+	}
+
+
+	public function setMetaTable(EE_Secondary_Table $meta_table)
+	{
+		$this->meta_table = $meta_table;
+	}
+
+
+	public function model(): ?EEM_CPT_Base
+	{
+		return $this->model;
+	}
+
+
+	protected function setModel(EEM_CPT_Base $CPT_model)
+	{
+		$this->model = $CPT_model;
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 * @deprecated 4.9.63.p
+	 */
+	public function request(): ?EE_Request_Handler
+	{
+		if (! $this->request_handler instanceof EE_Request_Handler) {
+			$this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->request_handler;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	public function WpQuery(): WP_Query
+	{
+		return $this->wp_query;
+	}
+
+
+	// phpcs:enable
+
+
+	public function setWpQuery(WP_Query $wp_query)
+	{
+		$this->wp_query = $wp_query;
+	}
+
+
+	protected function initializeTaxonomies()
+	{
+		// check if taxonomies have already been set and that this CPT has taxonomies registered for it
+		if (
+			empty($this->taxonomies)
+			&& isset($this->cpt_details['args']['taxonomies'])
+		) {
+			// if so then grab them, but we want the taxonomy name as the key
+			$taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
+			// then grab the list of ALL taxonomies
+			/** @var CustomTaxonomyDefinitions $taxonomy_definitions */
+			$taxonomy_definitions = $this->loader->getShared(CustomTaxonomyDefinitions::class);
+			$all_taxonomies       = $taxonomy_definitions->getCustomTaxonomyDefinitions();
+			foreach ($taxonomies as $taxonomy => &$details) {
+				// add details to our taxonomies if they exist
+				$details = $all_taxonomies[ $taxonomy ] ?? [];
+			}
+			// ALWAYS unset() variables that were passed by reference
+			unset($details);
+			$this->setTaxonomies($taxonomies);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.9.63.p
+	 */
+	protected function init()
+	{
+		$this->setAdditionalCptDetails();
+		$this->setRequestVarsIfCpt();
+		// convert post_type to model name
+		$model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
+		// load all tables related to CPT
+		$this->setupModelsAndTables($model_name);
+		// load and instantiate CPT_*_Strategy
+		$this->cpt_strategy = $this->cpt_strategy === null
+			? $this->cptStrategyClass($model_name)
+			: $this->cpt_strategy;
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		add_filter('posts_fields', [$this, 'postsFields'], 10, 2);
+		add_filter('posts_join', [$this, 'postsJoin'], 10, 2);
+		add_filter('the_posts', [$this, 'thePosts'], 1, 2);
+		if ($this->wp_query->is_main_query()) {
+			add_filter('get_edit_post_link', [$this, 'getEditPostLink'], 10, 2);
+			$this->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * sets some basic query vars that pertain to the CPT
+	 *
+	 * @return void
+	 */
+	protected function setAdditionalCptDetails()
+	{
+		// the post or category or term that is triggering EE
+		$this->cpt_details['espresso_page'] = $this->current_page->isEspressoPage();
+		// requested post name
+		$this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
+		// add support for viewing 'private', 'draft', or 'pending' posts
+		if (
+			isset($this->wp_query->query_vars['p'])
+			&& $this->wp_query->query_vars['p'] !== 0
+			&& is_user_logged_in()
+			&& current_user_can('edit_post', $this->wp_query->query_vars['p'])
+		) {
+			// we can just inject directly into the WP_Query object
+			$this->wp_query->query['post_status'] = ['publish', 'private', 'draft', 'pending'];
+			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
+			$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+		}
+	}
+
+
+	/**
+	 * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
+	 * If so, sets the 'ee' request variable
+	 * so other parts of EE can know what CPT is getting queried.
+	 * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
+	 * in order for is_archive() and is_single() methods to work properly.
+	 *
+	 * @return void
+	 */
+	public function setRequestVarsIfCpt()
+	{
+		// check if ee action var has been set
+		if (! $this->request->requestParamIsSet('ee')) {
+			// check that route exists for CPT archive slug
+			if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
+				// ie: set "ee" to "events"
+				$this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
+				// or does it match a single page CPT like /event/
+			} elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
+				// ie: set "ee" to "event"
+				$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+			}
+		}
+	}
+
+
+	/**
+	 * setupModelsAndTables
+	 *
+	 * @param string $model_name
+	 * @throws EE_Error
+	 */
+	protected function setupModelsAndTables(string $model_name)
+	{
+		// get CPT table data via CPT Model
+		$full_model_name = strpos($model_name, 'EEM_') !== 0
+			? 'EEM_' . $model_name
+			: $model_name;
+		$model           = $this->loader->getShared($full_model_name);
+		if (! $model instanceof EEM_CPT_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The "%1$s" model could not be loaded.',
+						'event_espresso'
+					),
+					$full_model_name
+				)
+			);
+		}
+		$this->setModel($model);
+		$this->setModelTables($this->model->get_tables());
+		$meta_model = $model_name . '_Meta';
+		// is there a Meta Table for this CPT?
+		if (
+			isset($this->cpt_details['tables'][ $meta_model ])
+			&& $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+		) {
+			$this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+		}
+	}
+
+
+	/**
+	 * cptStrategyClass
+	 *
+	 * @param string $model_name
+	 * @return EE_CPT_Event_Strategy|EE_CPT_Attendee_Strategy|EE_CPT_Default_Strategy|EE_CPT_Venue_Strategy
+	 */
+	protected function cptStrategyClass(string $model_name)
+	{
+		// creates classname like:  CPT_Event_Strategy
+		$CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+		// load and instantiate
+		$CPT_Strategy = $this->loader->getShared($CPT_Strategy_class_name, [$this->wp_query, $this->cpt_details]);
+		if ($CPT_Strategy === null) {
+			$CPT_Strategy = $this->loader->getShared('EE_CPT_Default_Strategy', [$this->wp_query, $this->cpt_details]);
+		}
+		return $CPT_Strategy;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function postsFields(string $SQL, WP_Query $wp_query): string
+	{
+		if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
+			return $SQL;
+		}
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
+			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+		}
+		remove_filter('posts_fields', [$this, 'postsFields']);
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function postsJoin(string $SQL, WP_Query $wp_query): string
+	{
+		if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
+			return $SQL;
+		}
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			global $wpdb;
+			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
+			$posts_table = $wpdb->posts;
+			$meta_table = $this->meta_table->get_table_name();
+			$foreign_key = $this->meta_table->get_fk_on_table();
+			$SQL .= " LEFT JOIN $meta_table ON ( $meta_table.$foreign_key = $posts_table.ID ) ";
+		}
+		remove_filter('posts_join', [$this, 'postsJoin']);
+		return $SQL;
+	}
+
+
+	/**
+	 * thePosts
+	 *
+	 * @param WP_Post[] $posts
+	 * @param WP_Query  $wp_query
+	 * @return WP_Post[]
+	 */
+	public function thePosts(array $posts, WP_Query $wp_query): array
+	{
+		if (EE_CPT_Strategy::instance()->wpQueryPostType($wp_query) !== $this->post_type) {
+			return $posts;
+		}
+		$CPT_class = $this->cpt_details['class_name'];
+		// loop thru posts
+		if ($this->model instanceof EEM_CPT_Base) {
+			foreach ($posts as $post) {
+				if ($post->post_type === $this->post_type) {
+					$post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
+				}
+			}
+		}
+		remove_filter('the_posts', [$this, 'thePosts'], 1);
+		return $posts;
+	}
+
+
+	/**
+	 * @param string|null $url
+	 * @param int    $ID
+	 * @return null|string
+	 */
+	public function getEditPostLink(?string $url, int $ID): ?string
+	{
+		// need to make sure we only edit links if our cpt
+		global $post;
+		// notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
+		// for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
+		if (
+			! $post instanceof WP_Post
+			|| $post->post_type !== $this->post_type
+			|| (
+				isset($this->cpt_details['args']['show_ee_ui'])
+				&& ! $this->cpt_details['args']['show_ee_ui']
+			)
+		) {
+			return $url;
+		}
+		// k made it here so all is good.
+		return wp_nonce_url(
+			add_query_arg(
+				['page' => $this->post_type, 'post' => $ID, 'action' => 'edit'],
+				admin_url('admin.php')
+			),
+			'edit',
+			'edit_nonce'
+		);
+	}
+
+
+	/**
+	 * Execute any template filters.
+	 * This method is only called if in main query.
+	 *
+	 * @return void
+	 */
+	public function addTemplateFilters()
+	{
+		// if requested cpt supports page_templates and it's the main query
+		if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+			// then let's hook into the appropriate query_template hook
+			add_filter('single_template', [$this, 'singleCptTemplate']);
+		}
+	}
+
+
+	/**
+	 * Callback for single_template wp filter.
+	 * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
+	 * hierarchy.
+	 *
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function singleCptTemplate(string $current_template): string
+	{
+		$object = get_queried_object();
+		// does this called object HAVE a page template set that is something other than the default.
+		$template = get_post_meta($object->ID, '_wp_page_template', true);
+		// exit early if default or not set or invalid path (accounts for theme changes)
+		if (
+			$template === 'default'
+			|| empty($template)
+			|| ! is_readable(get_stylesheet_directory() . '/' . $template)
+		) {
+			return $current_template;
+		}
+		// made it here so we SHOULD be able to just locate the template and then return it.
+		return locate_template([$template]);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -186,7 +186,7 @@ 
      */
     public function request(): ?EE_Request_Handler
     {
-        if (! $this->request_handler instanceof EE_Request_Handler) {
+        if ( ! $this->request_handler instanceof EE_Request_Handler) {
             $this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
         }
         return $this->request_handler;
@@ -226,7 +226,7 @@ 
             $all_taxonomies       = $taxonomy_definitions->getCustomTaxonomyDefinitions();
             foreach ($taxonomies as $taxonomy => &$details) {
                 // add details to our taxonomies if they exist
-                $details = $all_taxonomies[ $taxonomy ] ?? [];
+                $details = $all_taxonomies[$taxonomy] ?? [];
             }
             // ALWAYS unset() variables that were passed by reference
             unset($details);
@@ -309,7 +309,7 @@ 
     public function setRequestVarsIfCpt()
     {
         // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
+        if ( ! $this->request->requestParamIsSet('ee')) {
             // check that route exists for CPT archive slug
             if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
                 // ie: set "ee" to "events"
@@ -333,10 +333,10 @@ 
     {
         // get CPT table data via CPT Model
         $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
+            ? 'EEM_'.$model_name
             : $model_name;
         $model           = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_CPT_Base) {
+        if ( ! $model instanceof EEM_CPT_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -349,13 +349,13 @@ 
         }
         $this->setModel($model);
         $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
+        $meta_model = $model_name.'_Meta';
         // is there a Meta Table for this CPT?
         if (
-            isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+            isset($this->cpt_details['tables'][$meta_model])
+            && $this->cpt_details['tables'][$meta_model] instanceof EE_Secondary_Table
         ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+            $this->setMetaTable($this->cpt_details['tables'][$meta_model]);
         }
     }
 
@@ -369,7 +369,7 @@ 
     protected function cptStrategyClass(string $model_name)
     {
         // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+        $CPT_Strategy_class_name = 'EE_CPT_'.$model_name.'_Strategy';
         // load and instantiate
         $CPT_Strategy = $this->loader->getShared($CPT_Strategy_class_name, [$this->wp_query, $this->cpt_details]);
         if ($CPT_Strategy === null) {
@@ -392,7 +392,7 @@ 
         // does this CPT have a meta table ?
         if ($this->meta_table instanceof EE_Secondary_Table) {
             // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+            $SQL .= ', '.$this->meta_table->get_table_name().'.* ';
         }
         remove_filter('posts_fields', [$this, 'postsFields']);
         return $SQL;
@@ -491,7 +491,7 @@ 
     public function addTemplateFilters()
     {
         // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+        if ( ! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
             // then let's hook into the appropriate query_template hook
             add_filter('single_template', [$this, 'singleCptTemplate']);
         }
@@ -515,7 +515,7 @@ 
         if (
             $template === 'default'
             || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
+            || ! is_readable(get_stylesheet_directory().'/'.$template)
         ) {
             return $current_template;
         }

core/CPTs/EE_CPT_Attendee_Strategy.core.php

Indentation +24 added lines, -24 removed lines

@@ -9,32 +9,32 @@
  */
 class EE_CPT_Attendee_Strategy
 {
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     */
-    protected array $CPT;
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 */
+	protected array $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct(WP_Query $wp_query, array $CPT = [])
-    {
-        $this->CPT = $CPT;
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct(WP_Query $wp_query, array $CPT = [])
+	{
+		$this->CPT = $CPT;
+	}
 
 
-    /**
-     *    the_posts
-     *
-     * @access    public
-     * @param          $posts
-     * @param WP_Query $wp_query
-     * @return    void
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 *    the_posts
+	 *
+	 * @access    public
+	 * @param          $posts
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 }

core/EE_System.core.php

Indentation +1244 added lines, -1244 removed lines

@@ -26,1248 +26,1248 @@
  */
 final class EE_System implements ResettableInterface
 {
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var AddonManager $addon_manager
-     */
-    private $addon_manager;
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * @var Router $router
-     */
-    private $router;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
-     */
-    private $register_custom_post_types;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
-     */
-    private $register_custom_taxonomies;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
-     */
-    private $register_custom_taxonomy_terms;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null     $loader
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @param EE_Registry|null         $registry
-     * @param RequestInterface|null    $request
-     * @param Router|null              $router
-     * @return EE_System
-     */
-    public static function instance(
-        LoaderInterface $loader = null,
-        EE_Maintenance_Mode $maintenance_mode = null,
-        EE_Registry $registry = null,
-        RequestInterface $request = null,
-        Router $router = null
-    ): EE_System {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset(): EE_System
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param LoaderInterface     $loader
-     * @param EE_Maintenance_Mode $maintenance_mode
-     * @param EE_Registry         $registry
-     * @param RequestInterface    $request
-     * @param Router              $router
-     */
-    private function __construct(
-        LoaderInterface $loader,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry,
-        RequestInterface $request,
-        Router $router
-    ) {
-        $this->registry         = $registry;
-        $this->loader           = $loader;
-        $this->request          = $request;
-        $this->router           = $router;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadWpGraphQL'],
-            3
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCapabilities'],
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCommandBus'],
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadPluginApi'],
-            9
-        );
-        // give caff stuff a chance to play during the activation process too.
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'brewCaffeinated'],
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'load_espresso_addons']
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            [$this, 'detect_activations_or_upgrades'],
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'load_core_configuration'],
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadRouteMatchSpecifications']
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadCustomPostTypes']
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadCustomPostTypes']
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            [$this, 'register_shortcodes_modules_and_widgets'],
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            [$this, 'brew_espresso'],
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            [$this, 'remove_pages_from_wp_list_pages'],
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     */
-    public function loadWpGraphQL()
-    {
-        espressoLoadWpGraphQL();
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     * CommandBus middleware operate FIFO - First In First Out
-     * so LocateMovedCommands will run first in order to return any new commands
-     *
-     * @return void
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            [
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    [
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws Exception
-     */
-    public function loadPluginApi()
-    {
-        $this->addon_manager = $this->loader->getShared(AddonManager::class);
-        $this->addon_manager->initialize();
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws EE_Error
-     */
-    public function brewCaffeinated()
-    {
-        static $brew;
-        /** @var Domain $domain */
-        $domain = DomainFactory::getEventEspressoCoreDomain();
-        if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-            /** @var EE_Brewing_Regular $brew */
-            $brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
-            $brew->initializePUE();
-            add_action(
-                'AHEE__EE_System__load_core_configuration__begin',
-                [$brew, 'caffeinated']
-            );
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function load_espresso_addons()
-    {
-        // looking for hooks? they've been moved into the AddonManager to maintain compatibility
-        $this->addon_manager->loadAddons();
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type       = $this->detect_req_type($espresso_db_update);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change(array $espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = [];
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = [$espresso_db_update => []];
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = [];
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return ! empty($espresso_db_update)
-            ? $espresso_db_update
-            : [];
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if (! MaintenanceStatus::isFullSite()) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array|null $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                       If not supplied, fetches it from the options table.
-     *                                       Also, caches its result so later parts of the code can also know whether
-     *                                       there's been an update or not. This way we can add the current version to
-     *                                       espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type(?array $espresso_db_update = null): int
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update          = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type             = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history): bool
-    {
-        $previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts  = explode('.', espresso_version());
-        return isset(
-                   $previous_version_parts[0],
-                   $previous_version_parts[1],
-                   $current_version_parts[0],
-                   $current_version_parts[1]
-               ) && (
-                   $previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change(): bool
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array|null $activation_history               the option's value which stores the activation history for
-     *                                                     this
-     *                                                     ee plugin. for core that's 'espresso_db_update'
-     * @param string     $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                     indicate that this plugin was just activated
-     * @param string     $current_version                  the version that was just upgraded to (for core that will be
-     *                                                     espresso_version())
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public static function detect_req_type_given_activation_history(
-        array $activation_history,
-        string $activation_indicator_option_name,
-        string $current_version
-    ): int {
-        $version_change = self::compareVersionWithPrevious($activation_history, $current_version);
-        $is_activation  = get_option($activation_indicator_option_name, false);
-        $req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
-        if ($is_activation) {
-            // cleanup in aisle 6
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * @param array $activation_history
-     * @param int   $version_change
-     * @param bool  $is_activation
-     * @return int
-     * @since 5.0.0.p
-     */
-    private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
-    {
-        // if no previous activation history exists, then this is a brand new install
-        if (empty($activation_history)) {
-            return EE_System::req_type_new_activation;
-        }
-        // current version is higher than previous version, so it's an upgrade
-        if ($version_change === 1) {
-            return EE_System::req_type_upgrade;
-        }
-        // current version is lower than previous version, so it's a downgrade
-        if ($version_change === -1) {
-            return EE_System::req_type_downgrade;
-        }
-        // version hasn't changed since last version so check if the activation indicator is set
-        // to determine if it's a reactivation, or just a normal request
-        return $is_activation
-            ? EE_System::req_type_reactivation
-            : EE_System::req_type_normal;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history    array where keys are versions,
-     *                                      values are arrays of times activated (sometimes 'unknown-date')
-     * @param string $current_version
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
-    {
-        // find the most recently-activated version
-        $most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
-        return version_compare($current_version, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array|null $activation_history (keys are versions, values are arrays of times activated,
-     *                                       sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function getMostRecentlyActiveVersion(?array $activation_history): string
-    {
-        $most_recent_activation_date  = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $activation_dates) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $activation_dates) {
-                    $activation_dates = ['unknown-date'];
-                }
-                $activation_dates = is_string($activation_dates)
-                    ? [$activation_dates]
-                    : $activation_dates;
-                foreach ($activation_dates as $activation_date) {
-                    if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
-                        $most_recently_active_version = $version;
-                        $most_recent_activation_date  = $activation_date;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = ['page' => 'espresso_about'];
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            EEH_URL::safeRedirectAndExit($url);
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        $this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
-        $model_names            = [];
-        $non_abstract_db_models = [];
-        foreach ($models as $model) {
-            // get model classname
-            $classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name      = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * @throws Exception
-     * @since 4.9.71.p
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
-            $this->router->loadPrimaryRoutes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * loading CPT related classes earlier so that their definitions are available
-     * but not performing any actual registration with WP core until load_CPTs_and_session() is called
-     *
-     * @since   4.10.21.p
-     */
-    public function loadCustomPostTypes()
-    {
-        $this->register_custom_taxonomies     = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $this->register_custom_post_types     = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $this->register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        $this->router->registerShortcodesModulesAndWidgets();
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = WordPressHooks::getClassNamesForAllCallbacksOnHook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', [$this, 'set_hooks_for_core'], 1);
-        add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
-        add_action('init', [$this, 'load_CPTs_and_session'], 5);
-        add_action('init', [$this, 'load_controllers'], 7);
-        add_action('init', [$this, 'core_loaded_and_ready'], 9);
-        add_action('init', [$this, 'initialize'], 10);
-        add_action('init', [$this, 'initialize_last'], 100);
-        $this->router->brewEspresso();
-        $this->loader->getShared('EventEspresso\PaymentMethods\Manager');
-        $this->loader->getShared('EE_Payment_Method_Manager');
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->capabilities->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', []);
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        $this->register_custom_taxonomies->registerCustomTaxonomies();
-        $this->register_custom_post_types->registerCustomPostTypes();
-        $this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        $this->router->loadControllers();
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->router->coreLoadedAndReady();
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-        add_filter(
-            'safe_style_css',
-            function ($styles) {
-                $styles[] = 'display';
-                $styles[] = 'visibility';
-                $styles[] = 'position';
-                $styles[] = 'top';
-                $styles[] = 'right';
-                $styles[] = 'bottom';
-                $styles[] = 'left';
-                $styles[] = 'resize';
-                $styles[] = 'max-width';
-                $styles[] = 'max-height';
-                return $styles;
-            }
-        );
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function initialize_last()
-    {
-        $this->router->initializeLast();
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            [$this->capabilities]
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers): array
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages(array $exclude_array): array
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var AddonManager $addon_manager
+	 */
+	private $addon_manager;
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * @var Router $router
+	 */
+	private $router;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
+	 */
+	private $register_custom_post_types;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
+	 */
+	private $register_custom_taxonomies;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
+	 */
+	private $register_custom_taxonomy_terms;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @param EE_Registry|null         $registry
+	 * @param RequestInterface|null    $request
+	 * @param Router|null              $router
+	 * @return EE_System
+	 */
+	public static function instance(
+		LoaderInterface $loader = null,
+		EE_Maintenance_Mode $maintenance_mode = null,
+		EE_Registry $registry = null,
+		RequestInterface $request = null,
+		Router $router = null
+	): EE_System {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset(): EE_System
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param LoaderInterface     $loader
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 * @param EE_Registry         $registry
+	 * @param RequestInterface    $request
+	 * @param Router              $router
+	 */
+	private function __construct(
+		LoaderInterface $loader,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry,
+		RequestInterface $request,
+		Router $router
+	) {
+		$this->registry         = $registry;
+		$this->loader           = $loader;
+		$this->request          = $request;
+		$this->router           = $router;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadWpGraphQL'],
+			3
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCapabilities'],
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCommandBus'],
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadPluginApi'],
+			9
+		);
+		// give caff stuff a chance to play during the activation process too.
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'brewCaffeinated'],
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'load_espresso_addons']
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			[$this, 'detect_activations_or_upgrades'],
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'load_core_configuration'],
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadRouteMatchSpecifications']
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadCustomPostTypes']
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadCustomPostTypes']
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			[$this, 'register_shortcodes_modules_and_widgets'],
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			[$this, 'brew_espresso'],
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			[$this, 'remove_pages_from_wp_list_pages'],
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 */
+	public function loadWpGraphQL()
+	{
+		espressoLoadWpGraphQL();
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 * CommandBus middleware operate FIFO - First In First Out
+	 * so LocateMovedCommands will run first in order to return any new commands
+	 *
+	 * @return void
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			[
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					[
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Exception
+	 */
+	public function loadPluginApi()
+	{
+		$this->addon_manager = $this->loader->getShared(AddonManager::class);
+		$this->addon_manager->initialize();
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws EE_Error
+	 */
+	public function brewCaffeinated()
+	{
+		static $brew;
+		/** @var Domain $domain */
+		$domain = DomainFactory::getEventEspressoCoreDomain();
+		if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+			/** @var EE_Brewing_Regular $brew */
+			$brew = LoaderFactory::getLoader()->getShared(EE_Brewing_Regular::class);
+			$brew->initializePUE();
+			add_action(
+				'AHEE__EE_System__load_core_configuration__begin',
+				[$brew, 'caffeinated']
+			);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_espresso_addons()
+	{
+		// looking for hooks? they've been moved into the AddonManager to maintain compatibility
+		$this->addon_manager->loadAddons();
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type       = $this->detect_req_type($espresso_db_update);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change(array $espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = [];
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = [$espresso_db_update => []];
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = [];
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string                         = $should_be_array;
+					$corrected_db_update[ $version_string ] = ['unknown-date'];
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return ! empty($espresso_db_update)
+			? $espresso_db_update
+			: [];
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if (! MaintenanceStatus::isFullSite()) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array|null $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                       If not supplied, fetches it from the options table.
+	 *                                       Also, caches its result so later parts of the code can also know whether
+	 *                                       there's been an update or not. This way we can add the current version to
+	 *                                       espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type(?array $espresso_db_update = null): int
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update          = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type             = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history): bool
+	{
+		$previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts  = explode('.', espresso_version());
+		return isset(
+				   $previous_version_parts[0],
+				   $previous_version_parts[1],
+				   $current_version_parts[0],
+				   $current_version_parts[1]
+			   ) && (
+				   $previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change(): bool
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array|null $activation_history               the option's value which stores the activation history for
+	 *                                                     this
+	 *                                                     ee plugin. for core that's 'espresso_db_update'
+	 * @param string     $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                     indicate that this plugin was just activated
+	 * @param string     $current_version                  the version that was just upgraded to (for core that will be
+	 *                                                     espresso_version())
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public static function detect_req_type_given_activation_history(
+		array $activation_history,
+		string $activation_indicator_option_name,
+		string $current_version
+	): int {
+		$version_change = self::compareVersionWithPrevious($activation_history, $current_version);
+		$is_activation  = get_option($activation_indicator_option_name, false);
+		$req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
+		if ($is_activation) {
+			// cleanup in aisle 6
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * @param array $activation_history
+	 * @param int   $version_change
+	 * @param bool  $is_activation
+	 * @return int
+	 * @since 5.0.0.p
+	 */
+	private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
+	{
+		// if no previous activation history exists, then this is a brand new install
+		if (empty($activation_history)) {
+			return EE_System::req_type_new_activation;
+		}
+		// current version is higher than previous version, so it's an upgrade
+		if ($version_change === 1) {
+			return EE_System::req_type_upgrade;
+		}
+		// current version is lower than previous version, so it's a downgrade
+		if ($version_change === -1) {
+			return EE_System::req_type_downgrade;
+		}
+		// version hasn't changed since last version so check if the activation indicator is set
+		// to determine if it's a reactivation, or just a normal request
+		return $is_activation
+			? EE_System::req_type_reactivation
+			: EE_System::req_type_normal;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history    array where keys are versions,
+	 *                                      values are arrays of times activated (sometimes 'unknown-date')
+	 * @param string $current_version
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
+	{
+		// find the most recently-activated version
+		$most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
+		return version_compare($current_version, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array|null $activation_history (keys are versions, values are arrays of times activated,
+	 *                                       sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function getMostRecentlyActiveVersion(?array $activation_history): string
+	{
+		$most_recent_activation_date  = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $activation_dates) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $activation_dates) {
+					$activation_dates = ['unknown-date'];
+				}
+				$activation_dates = is_string($activation_dates)
+					? [$activation_dates]
+					: $activation_dates;
+				foreach ($activation_dates as $activation_date) {
+					if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
+						$most_recently_active_version = $version;
+						$most_recent_activation_date  = $activation_date;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = ['page' => 'espresso_about'];
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			EEH_URL::safeRedirectAndExit($url);
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		$this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models                 = glob(EE_MODELS . '*.model.php');
+		$model_names            = [];
+		$non_abstract_db_models = [];
+		foreach ($models as $model) {
+			// get model classname
+			$classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name      = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * @throws Exception
+	 * @since 4.9.71.p
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
+			$this->router->loadPrimaryRoutes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * loading CPT related classes earlier so that their definitions are available
+	 * but not performing any actual registration with WP core until load_CPTs_and_session() is called
+	 *
+	 * @since   4.10.21.p
+	 */
+	public function loadCustomPostTypes()
+	{
+		$this->register_custom_taxonomies     = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$this->register_custom_post_types     = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$this->register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		$this->router->registerShortcodesModulesAndWidgets();
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = WordPressHooks::getClassNamesForAllCallbacksOnHook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', [$this, 'set_hooks_for_core'], 1);
+		add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
+		add_action('init', [$this, 'load_CPTs_and_session'], 5);
+		add_action('init', [$this, 'load_controllers'], 7);
+		add_action('init', [$this, 'core_loaded_and_ready'], 9);
+		add_action('init', [$this, 'initialize'], 10);
+		add_action('init', [$this, 'initialize_last'], 100);
+		$this->router->brewEspresso();
+		$this->loader->getShared('EventEspresso\PaymentMethods\Manager');
+		$this->loader->getShared('EE_Payment_Method_Manager');
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+    /**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->capabilities->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', []);
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', []);
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		$this->register_custom_taxonomies->registerCustomTaxonomies();
+		$this->register_custom_post_types->registerCustomPostTypes();
+		$this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		$this->router->loadControllers();
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->router->coreLoadedAndReady();
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+		add_filter(
+			'safe_style_css',
+			function ($styles) {
+				$styles[] = 'display';
+				$styles[] = 'visibility';
+				$styles[] = 'position';
+				$styles[] = 'top';
+				$styles[] = 'right';
+				$styles[] = 'bottom';
+				$styles[] = 'left';
+				$styles[] = 'resize';
+				$styles[] = 'max-width';
+				$styles[] = 'max-height';
+				return $styles;
+			}
+		);
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize_last()
+	{
+		$this->router->initializeLast();
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			[$this->capabilities]
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers): array
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages(array $exclude_array): array
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 }

core/domain/services/admin/notices/status_change/StatusChangeNotice.php

Indentation +96 added lines, -96 removed lines

@@ -16,112 +16,112 @@
  */
 class StatusChangeNotice extends WordPressOption
 {
-    public function __construct()
-    {
-        parent::__construct('ee_hide_status_change_notices_for_users', []);
-    }
+	public function __construct()
+	{
+		parent::__construct('ee_hide_status_change_notices_for_users', []);
+	}
 
 
-    public static function loadAssets()
-    {
-        wp_enqueue_style(
-            'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.css',
-            ['espresso_menu'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script(
-            'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'status_change_notice',
-            'eeStatusChangeNotice',
-            [
-                'failed_request_msg' => wp_strip_all_tags(
-                    __(
-                        'Request failed. The server returned status code: ',
-                        'event_espresso'
-                    )
-                ),
-                'unknown_error_msg' => wp_strip_all_tags(
-                    __(
-                        'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
-                        'event_espresso'
-                    )
-                ),
-            ]
-        );
-    }
+	public static function loadAssets()
+	{
+		wp_enqueue_style(
+			'status_change_notice',
+			EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.css',
+			['espresso_menu'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script(
+			'status_change_notice',
+			EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'status_change_notice',
+			'eeStatusChangeNotice',
+			[
+				'failed_request_msg' => wp_strip_all_tags(
+					__(
+						'Request failed. The server returned status code: ',
+						'event_espresso'
+					)
+				),
+				'unknown_error_msg' => wp_strip_all_tags(
+					__(
+						'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
+						'event_espresso'
+					)
+				),
+			]
+		);
+	}
 
 
-    public function display(string $context, string $page_slug): string
-    {
-        return $this->isNotDismissed()
-            ? EEH_Template::display_template(
-                __DIR__ . '/status_change_notice.template.php',
-                [
-                    'context'   => $context,
-                    'page_slug' => ! empty($page_slug) ? "$page_slug-page" : '',
-                ],
-                true
-            )
-            : '';
-    }
+	public function display(string $context, string $page_slug): string
+	{
+		return $this->isNotDismissed()
+			? EEH_Template::display_template(
+				__DIR__ . '/status_change_notice.template.php',
+				[
+					'context'   => $context,
+					'page_slug' => ! empty($page_slug) ? "$page_slug-page" : '',
+				],
+				true
+			)
+			: '';
+	}
 
 
-    /**
-     * @return int
-     * @throws RuntimeException
-     */
-    public function dismiss(): int
-    {
-        $user      = $this->getCurrentUser();
-        $dismissed = (array) $this->loadOption();
-        if (! in_array($user, $dismissed)) {
-            $dismissed[] = $user;
-        }
-        return $this->updateOption($dismissed);
-    }
+	/**
+	 * @return int
+	 * @throws RuntimeException
+	 */
+	public function dismiss(): int
+	{
+		$user      = $this->getCurrentUser();
+		$dismissed = (array) $this->loadOption();
+		if (! in_array($user, $dismissed)) {
+			$dismissed[] = $user;
+		}
+		return $this->updateOption($dismissed);
+	}
 
 
-    /**
-     * @return bool
-     * @throws RuntimeException
-     */
-    public function isDismissed(): bool
-    {
-        $user      = $this->getCurrentUser();
-        $dismissed = (array) $this->loadOption();
-        return in_array($user, $dismissed);
-    }
+	/**
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	public function isDismissed(): bool
+	{
+		$user      = $this->getCurrentUser();
+		$dismissed = (array) $this->loadOption();
+		return in_array($user, $dismissed);
+	}
 
 
-    /**
-     * @return bool
-     * @throws RuntimeException
-     */
-    public function isNotDismissed(): bool
-    {
-        return ! $this->isDismissed();
-    }
+	/**
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	public function isNotDismissed(): bool
+	{
+		return ! $this->isDismissed();
+	}
 
 
-    /**
-     * @return string
-     * @throws RuntimeException
-     */
-    private function getCurrentUser(): string
-    {
-        $user = wp_get_current_user();
-        if (! $user instanceof WP_User || ! $user->exists()) {
-            throw new RuntimeException(
-                esc_html__('A valid WP User could not be retrieved.', 'event_espresso')
-            );
-        }
-        return $user->user_login;
-    }
+	/**
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	private function getCurrentUser(): string
+	{
+		$user = wp_get_current_user();
+		if (! $user instanceof WP_User || ! $user->exists()) {
+			throw new RuntimeException(
+				esc_html__('A valid WP User could not be retrieved.', 'event_espresso')
+			);
+		}
+		return $user->user_login;
+	}
 }

core/domain/services/admin/registrations/list_table/QueryBuilder.php

Indentation +412 added lines, -412 removed lines

@@ -22,416 +22,416 @@
  */
 class QueryBuilder
 {
-    protected RequestInterface $request;
-
-    protected EEM_Registration $registration_model;
-
-    protected array $filters;
-
-    protected string $view;
-
-    protected array $where_params;
-
-
-    /**
-     * QueryBuilder constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Registration $registration_model
-     * @param array            $extra_request_params
-     */
-    public function __construct(
-        RequestInterface $request,
-        EEM_Registration $registration_model,
-        array $extra_request_params = []
-    ) {
-        $this->request = $request;
-        $this->filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
-        $this->registration_model = $registration_model;
-        foreach ($extra_request_params as $key => $value) {
-            if (! $this->request->requestParamIsSet($key)) {
-                $this->request->setRequestParam($key, $value);
-            }
-        }
-        $this->view = $this->request->getRequestParam('status', '');
-        $this->where_params = [];
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param int  $per_page
-     * @param bool $count_query
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getQueryParams(int $per_page = 10, bool $count_query = false): array
-    {
-        $query_params = [
-            0                          => $this->getWhereClause(),
-            'caps'                     => EEM_Base::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        ];
-        if (! $count_query) {
-            $query_params = array_merge(
-                $query_params,
-                $this->getOrderbyClause(),
-                $this->getLimitClause($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getWhereClause(): array
-    {
-        $this->addAttendeeIdToWhereConditions();
-        $this->addEventIdToWhereConditions();
-        $this->addCategoryIdToWhereConditions();
-        $this->addDatetimeIdToWhereConditions();
-        $this->addTicketIdToWhereConditions();
-        $this->addRegistrationStatusToWhereConditions();
-        $this->addDateToWhereConditions();
-        $this->addSearchToWhereConditions();
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            $this->where_params,
-            $this->request->requestParams()
-        );
-    }
-
-
-    /**
-     * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addAttendeeIdToWhereConditions()
-    {
-        $ATT_ID = $this->request->getRequestParam('attendee_id');
-        $ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
-        if ($ATT_ID) {
-            $this->where_params['ATT_ID'] = $ATT_ID;
-        }
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addEventIdToWhereConditions()
-    {
-        $EVT_ID = $this->request->getRequestParam('event_id');
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
-        if ($EVT_ID) {
-            $this->where_params['EVT_ID'] = $EVT_ID;
-        }
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addCategoryIdToWhereConditions()
-    {
-        $EVT_CAT = $this->request->getRequestParam('EVT_CAT', 0, DataType::INTEGER);
-        $EVT_CAT = $this->filters['EVT_CAT'] ?? $EVT_CAT;
-        $EVT_CAT = (int) $EVT_CAT;
-        if ($EVT_CAT > 0) {
-            $this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
-        }
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addDatetimeIdToWhereConditions()
-    {
-        // first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
-        $DTT_ID = $this->request->getRequestParam('datetime_id');
-        $DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, DataType::INTEGER);
-        $DTT_ID = $this->filters['datetime_id'] ?? $DTT_ID;
-        $DTT_ID = (int) $DTT_ID;
-
-        if ($DTT_ID) {
-            $this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addTicketIdToWhereConditions()
-    {
-        // first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
-        $TKT_ID = $this->request->getRequestParam('ticket_id');
-        $TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, DataType::INTEGER);
-        $TKT_ID = $this->filters['ticket_id'] ?? $TKT_ID;
-        $TKT_ID = (int) $TKT_ID;
-
-        if ($TKT_ID) {
-            $this->where_params['TKT_ID'] = $TKT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     * If filtering by registration status, then we show registrations matching that status.
-     * If not filtering by specified status, then we show all registrations excluding incomplete registrations
-     * UNLESS viewing trashed registrations.
-     */
-    protected function addRegistrationStatusToWhereConditions()
-    {
-        $registration_status = $this->request->getRequestParam('_reg_status');
-        $registration_status = $this->filters['_reg_status'] ?? $registration_status;
-        if ($registration_status) {
-            $this->where_params['STS_ID'] = sanitize_text_field($registration_status);
-            return;
-        }
-        // make sure we exclude incomplete registrations, but only if not trashed.
-        if ($this->view === 'trash') {
-            $this->where_params['REG_deleted'] = true;
-            return;
-        }
-        $this->where_params['STS_ID'] = $this->view === 'incomplete'
-            ? EEM_Registration::status_id_incomplete
-            : ['!=', EEM_Registration::status_id_incomplete];
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function addDateToWhereConditions()
-    {
-        $current_time = current_time('timestamp');
-        $timezone_string = EEH_DTT_Helper::get_timezone();
-        if ($this->view === 'today') {
-            $now = date('Y-m-d', $current_time);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        if ($this->view === 'yesterday') {
-            $yesterday = date('Y-m-d', $current_time - DAY_IN_SECONDS);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $yesterday . ' 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $yesterday . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        if ($this->view === 'month') {
-            $current_year_and_month = date('Y-m', $current_time);
-            $days_this_month = date('t', $current_time);
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s',
-                        $timezone_string
-                    ),
-                ],
-            ];
-            return;
-        }
-        $month_range = $this->request->getRequestParam('month_range');
-        $month_range = $this->filters['month_range'] ?? $month_range;
-        if ($month_range) {
-            $month_range = sanitize_text_field($month_range);
-            $pieces = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            // if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $this->where_params['REG_date'] = [
-                    'BETWEEN',
-                    [
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s',
-                            $timezone_string
-                        ),
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s',
-                            $timezone_string
-                        ),
-                    ],
-                ];
-            }
-        }
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     */
-    protected function addSearchToWhereConditions()
-    {
-        $search = $this->request->getRequestParam('s');
-        if ($search) {
-            $search_string = '%' . sanitize_text_field($search) . '%';
-            $this->where_params['OR*search_conditions'] = [
-                'Event.EVT_name'                          => ['LIKE', $search_string],
-                'Event.EVT_desc'                          => ['LIKE', $search_string],
-                'Event.EVT_short_desc'                    => ['LIKE', $search_string],
-                'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
-                'Attendee.ATT_fname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_lname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
-                'Attendee.ATT_email'                      => ['LIKE', $search_string],
-                'Attendee.ATT_address'                    => ['LIKE', $search_string],
-                'Attendee.ATT_address2'                   => ['LIKE', $search_string],
-                'Attendee.ATT_city'                       => ['LIKE', $search_string],
-                'REG_final_price'                         => ['LIKE', $search_string],
-                'REG_code'                                => ['LIKE', $search_string],
-                'REG_count'                               => ['LIKE', $search_string],
-                'REG_group_size'                          => ['LIKE', $search_string],
-                'Ticket.TKT_name'                         => ['LIKE', $search_string],
-                'Ticket.TKT_description'                  => ['LIKE', $search_string],
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
-            ];
-        }
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function getOrderbyClause(): array
-    {
-        $orderby_field = $this->request->getRequestParam('orderby');
-        $orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby = ['REG_ID'];
-                break;
-            case '_Reg_status':
-                $orderby = ['STS_ID'];
-                break;
-            case 'ATT_fname':
-                $orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
-                break;
-            case 'ATT_lname':
-                $orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
-                break;
-            case 'event_name':
-                $orderby = ['Event.EVT_name'];
-                break;
-            case 'DTT_EVT_start':
-                $orderby = ['Event.Datetime.DTT_EVT_start'];
-                break;
-            case '_REG_date':
-                $orderby = ['REG_date'];
-                break;
-            default:
-                $orderby = [$orderby_field];
-                break;
-        }
-        $order = $this->request->getRequestParam('order');
-        $order = $order ? sanitize_text_field($order) : 'DESC';
-
-        $orderby = array_combine(
-            $orderby,
-            array_fill(0, count($orderby), $order)
-        );
-        // always add REG_count to the orderby array
-        $orderby['REG_count'] = 'ASC';
-        // because there are many registrations with the same date, define
-        // a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($orderby['REG_ID'])) {
-            $orderby['REG_ID'] = $order;
-        }
-
-        $orderby = apply_filters(
-            'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
-            $orderby,
-            $this->request->requestParams()
-        );
-        return ['order_by' => $orderby];
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param int $per_page
-     * @return array
-     */
-    protected function getLimitClause(int $per_page): array
-    {
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
-        // -1 means return all results so get out if that's set.
-        if ($per_page === -1) {
-            return [];
-        }
-        $offset = ($current_page - 1) * $per_page;
-        return ['limit' => [$offset, $per_page]];
-    }
+	protected RequestInterface $request;
+
+	protected EEM_Registration $registration_model;
+
+	protected array $filters;
+
+	protected string $view;
+
+	protected array $where_params;
+
+
+	/**
+	 * QueryBuilder constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Registration $registration_model
+	 * @param array            $extra_request_params
+	 */
+	public function __construct(
+		RequestInterface $request,
+		EEM_Registration $registration_model,
+		array $extra_request_params = []
+	) {
+		$this->request = $request;
+		$this->filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
+		$this->registration_model = $registration_model;
+		foreach ($extra_request_params as $key => $value) {
+			if (! $this->request->requestParamIsSet($key)) {
+				$this->request->setRequestParam($key, $value);
+			}
+		}
+		$this->view = $this->request->getRequestParam('status', '');
+		$this->where_params = [];
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count_query
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getQueryParams(int $per_page = 10, bool $count_query = false): array
+	{
+		$query_params = [
+			0                          => $this->getWhereClause(),
+			'caps'                     => EEM_Base::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		];
+		if (! $count_query) {
+			$query_params = array_merge(
+				$query_params,
+				$this->getOrderbyClause(),
+				$this->getLimitClause($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getWhereClause(): array
+	{
+		$this->addAttendeeIdToWhereConditions();
+		$this->addEventIdToWhereConditions();
+		$this->addCategoryIdToWhereConditions();
+		$this->addDatetimeIdToWhereConditions();
+		$this->addTicketIdToWhereConditions();
+		$this->addRegistrationStatusToWhereConditions();
+		$this->addDateToWhereConditions();
+		$this->addSearchToWhereConditions();
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			$this->where_params,
+			$this->request->requestParams()
+		);
+	}
+
+
+	/**
+	 * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addAttendeeIdToWhereConditions()
+	{
+		$ATT_ID = $this->request->getRequestParam('attendee_id');
+		$ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
+		if ($ATT_ID) {
+			$this->where_params['ATT_ID'] = $ATT_ID;
+		}
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addEventIdToWhereConditions()
+	{
+		$EVT_ID = $this->request->getRequestParam('event_id');
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
+		if ($EVT_ID) {
+			$this->where_params['EVT_ID'] = $EVT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addCategoryIdToWhereConditions()
+	{
+		$EVT_CAT = $this->request->getRequestParam('EVT_CAT', 0, DataType::INTEGER);
+		$EVT_CAT = $this->filters['EVT_CAT'] ?? $EVT_CAT;
+		$EVT_CAT = (int) $EVT_CAT;
+		if ($EVT_CAT > 0) {
+			$this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
+		}
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addDatetimeIdToWhereConditions()
+	{
+		// first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
+		$DTT_ID = $this->request->getRequestParam('datetime_id');
+		$DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, DataType::INTEGER);
+		$DTT_ID = $this->filters['datetime_id'] ?? $DTT_ID;
+		$DTT_ID = (int) $DTT_ID;
+
+		if ($DTT_ID) {
+			$this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addTicketIdToWhereConditions()
+	{
+		// first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
+		$TKT_ID = $this->request->getRequestParam('ticket_id');
+		$TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, DataType::INTEGER);
+		$TKT_ID = $this->filters['ticket_id'] ?? $TKT_ID;
+		$TKT_ID = (int) $TKT_ID;
+
+		if ($TKT_ID) {
+			$this->where_params['TKT_ID'] = $TKT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 * If filtering by registration status, then we show registrations matching that status.
+	 * If not filtering by specified status, then we show all registrations excluding incomplete registrations
+	 * UNLESS viewing trashed registrations.
+	 */
+	protected function addRegistrationStatusToWhereConditions()
+	{
+		$registration_status = $this->request->getRequestParam('_reg_status');
+		$registration_status = $this->filters['_reg_status'] ?? $registration_status;
+		if ($registration_status) {
+			$this->where_params['STS_ID'] = sanitize_text_field($registration_status);
+			return;
+		}
+		// make sure we exclude incomplete registrations, but only if not trashed.
+		if ($this->view === 'trash') {
+			$this->where_params['REG_deleted'] = true;
+			return;
+		}
+		$this->where_params['STS_ID'] = $this->view === 'incomplete'
+			? EEM_Registration::status_id_incomplete
+			: ['!=', EEM_Registration::status_id_incomplete];
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function addDateToWhereConditions()
+	{
+		$current_time = current_time('timestamp');
+		$timezone_string = EEH_DTT_Helper::get_timezone();
+		if ($this->view === 'today') {
+			$now = date('Y-m-d', $current_time);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		if ($this->view === 'yesterday') {
+			$yesterday = date('Y-m-d', $current_time - DAY_IN_SECONDS);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$yesterday . ' 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$yesterday . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		if ($this->view === 'month') {
+			$current_year_and_month = date('Y-m', $current_time);
+			$days_this_month = date('t', $current_time);
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s',
+						$timezone_string
+					),
+				],
+			];
+			return;
+		}
+		$month_range = $this->request->getRequestParam('month_range');
+		$month_range = $this->filters['month_range'] ?? $month_range;
+		if ($month_range) {
+			$month_range = sanitize_text_field($month_range);
+			$pieces = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			// if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$this->where_params['REG_date'] = [
+					'BETWEEN',
+					[
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s',
+							$timezone_string
+						),
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s',
+							$timezone_string
+						),
+					],
+				];
+			}
+		}
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 */
+	protected function addSearchToWhereConditions()
+	{
+		$search = $this->request->getRequestParam('s');
+		if ($search) {
+			$search_string = '%' . sanitize_text_field($search) . '%';
+			$this->where_params['OR*search_conditions'] = [
+				'Event.EVT_name'                          => ['LIKE', $search_string],
+				'Event.EVT_desc'                          => ['LIKE', $search_string],
+				'Event.EVT_short_desc'                    => ['LIKE', $search_string],
+				'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
+				'Attendee.ATT_fname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_lname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
+				'Attendee.ATT_email'                      => ['LIKE', $search_string],
+				'Attendee.ATT_address'                    => ['LIKE', $search_string],
+				'Attendee.ATT_address2'                   => ['LIKE', $search_string],
+				'Attendee.ATT_city'                       => ['LIKE', $search_string],
+				'REG_final_price'                         => ['LIKE', $search_string],
+				'REG_code'                                => ['LIKE', $search_string],
+				'REG_count'                               => ['LIKE', $search_string],
+				'REG_group_size'                          => ['LIKE', $search_string],
+				'Ticket.TKT_name'                         => ['LIKE', $search_string],
+				'Ticket.TKT_description'                  => ['LIKE', $search_string],
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
+			];
+		}
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function getOrderbyClause(): array
+	{
+		$orderby_field = $this->request->getRequestParam('orderby');
+		$orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby = ['REG_ID'];
+				break;
+			case '_Reg_status':
+				$orderby = ['STS_ID'];
+				break;
+			case 'ATT_fname':
+				$orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
+				break;
+			case 'ATT_lname':
+				$orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
+				break;
+			case 'event_name':
+				$orderby = ['Event.EVT_name'];
+				break;
+			case 'DTT_EVT_start':
+				$orderby = ['Event.Datetime.DTT_EVT_start'];
+				break;
+			case '_REG_date':
+				$orderby = ['REG_date'];
+				break;
+			default:
+				$orderby = [$orderby_field];
+				break;
+		}
+		$order = $this->request->getRequestParam('order');
+		$order = $order ? sanitize_text_field($order) : 'DESC';
+
+		$orderby = array_combine(
+			$orderby,
+			array_fill(0, count($orderby), $order)
+		);
+		// always add REG_count to the orderby array
+		$orderby['REG_count'] = 'ASC';
+		// because there are many registrations with the same date, define
+		// a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($orderby['REG_ID'])) {
+			$orderby['REG_ID'] = $order;
+		}
+
+		$orderby = apply_filters(
+			'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
+			$orderby,
+			$this->request->requestParams()
+		);
+		return ['order_by' => $orderby];
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param int $per_page
+	 * @return array
+	 */
+	protected function getLimitClause(int $per_page): array
+	{
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
+		// -1 means return all results so get out if that's set.
+		if ($per_page === -1) {
+			return [];
+		}
+		$offset = ($current_page - 1) * $per_page;
+		return ['limit' => [$offset, $per_page]];
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -49,7 +49,7 @@ 
         $this->filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
         $this->registration_model = $registration_model;
         foreach ($extra_request_params as $key => $value) {
-            if (! $this->request->requestParamIsSet($key)) {
+            if ( ! $this->request->requestParamIsSet($key)) {
                 $this->request->setRequestParam($key, $value);
             }
         }
@@ -76,7 +76,7 @@ 
             'caps'                     => EEM_Base::caps_read_admin,
             'default_where_conditions' => 'this_model_only',
         ];
-        if (! $count_query) {
+        if ( ! $count_query) {
             $query_params = array_merge(
                 $query_params,
                 $this->getOrderbyClause(),
@@ -233,13 +233,13 @@ 
                 [
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 00:00:00',
+                        $now.' 00:00:00',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 23:59:59',
+                        $now.' 23:59:59',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
@@ -254,13 +254,13 @@ 
                 [
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $yesterday . ' 00:00:00',
+                        $yesterday.' 00:00:00',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $yesterday . ' 23:59:59',
+                        $yesterday.' 23:59:59',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
@@ -276,13 +276,13 @@ 
                 [
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
+                        $current_year_and_month.'-01 00:00:00',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
                     $this->registration_model->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+                        $current_year_and_month.'-'.$days_this_month.' 23:59:59',
                         'Y-m-d H:i:s',
                         $timezone_string
                     ),
@@ -303,19 +303,19 @@ 
                 : '';
             // if there is not a month or year then we can't go further
             if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+                $days_in_month = date('t', strtotime($year_requested.'-'.$month_requested.'-'.'01'));
                 $this->where_params['REG_date'] = [
                     'BETWEEN',
                     [
                         $this->registration_model->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
+                            $year_requested.'-'.$month_requested.'-01 00:00:00',
                             'Y-m-d H:i:s',
                             $timezone_string
                         ),
                         $this->registration_model->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+                            $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59',
                             'Y-m-d H:i:s',
                             $timezone_string
                         ),
@@ -333,7 +333,7 @@ 
     {
         $search = $this->request->getRequestParam('s');
         if ($search) {
-            $search_string = '%' . sanitize_text_field($search) . '%';
+            $search_string = '%'.sanitize_text_field($search).'%';
             $this->where_params['OR*search_conditions'] = [
                 'Event.EVT_name'                          => ['LIKE', $search_string],
                 'Event.EVT_desc'                          => ['LIKE', $search_string],

core/domain/entities/custom_post_types/CustomTaxonomyDefinitions.php

Indentation +119 added lines, -119 removed lines

@@ -14,133 +14,133 @@
  */
 class CustomTaxonomyDefinitions
 {
-    private array $taxonomies = [];
+	private array $taxonomies = [];
 
 
-    public function __construct()
-    {
-        $this->setTaxonomies();
-        add_filter('pre_term_description', [$this, 'filterCustomTermDescription'], 1, 2);
-    }
+	public function __construct()
+	{
+		$this->setTaxonomies();
+		add_filter('pre_term_description', [$this, 'filterCustomTermDescription'], 1, 2);
+	}
 
 
-    private function setTaxonomies()
-    {
-        $this->taxonomies = [
-            'espresso_event_categories' => [
-                'singular_name' => esc_html__('Event Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
-                'args'          => [
-                    'public'            => true,
-                    'show_in_nav_menus' => true,
-                    'show_in_rest'      => true,
-                    'capabilities'      => [
-                        'manage_terms' => 'ee_manage_event_categories',
-                        'edit_terms'   => 'ee_edit_event_category',
-                        'delete_terms' => 'ee_delete_event_category',
-                        'assign_terms' => 'ee_assign_event_category',
-                    ],
-                    'rewrite'           => [
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('event-category', 'event_espresso'),
-                            'event-category'
-                        ),
-                    ],
-                ],
-            ],
-            'espresso_venue_categories' => [
-                'singular_name' => esc_html__('Venue Category', 'event_espresso'),
-                'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
-                'args'          => [
-                    'public'            => true,
-                    'show_in_nav_menus' => false, // by default this doesn't show for decaf
-                    'show_in_rest'      => true,
-                    'capabilities'      => [
-                        'manage_terms' => 'ee_manage_venue_categories',
-                        'edit_terms'   => 'ee_edit_venue_category',
-                        'delete_terms' => 'ee_delete_venue_category',
-                        'assign_terms' => 'ee_assign_venue_category',
-                    ],
-                    'rewrite'           => [
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('venue-category', 'event_espresso'),
-                            'venue-category'
-                        ),
-                    ],
-                ],
-            ],
-            'espresso_event_type'       => [
-                'singular_name' => esc_html__('Event Type', 'event_espresso'),
-                'plural_name'   => esc_html__('Event Types', 'event_espresso'),
-                'args'          => [
-                    'public'       => true,
-                    'show_ui'      => false,
-                    'show_in_rest' => true,
-                    'capabilities' => [
-                        'manage_terms' => 'ee_read_event_type',
-                        'edit_terms'   => 'ee_edit_event_type',
-                        'delete_terms' => 'ee_delete_event_type',
-                        'assign_terms' => 'ee_assign_event_type',
-                    ],
-                    'rewrite'      => [
-                        'slug' => EEH_URL::slugify(
-                            esc_html__('event-type', 'event_espresso'),
-                            'event-type'
-                        ),
-                    ],
-                    'hierarchical' => true,
-                ],
-            ],
-        ];
-    }
+	private function setTaxonomies()
+	{
+		$this->taxonomies = [
+			'espresso_event_categories' => [
+				'singular_name' => esc_html__('Event Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Categories', 'event_espresso'),
+				'args'          => [
+					'public'            => true,
+					'show_in_nav_menus' => true,
+					'show_in_rest'      => true,
+					'capabilities'      => [
+						'manage_terms' => 'ee_manage_event_categories',
+						'edit_terms'   => 'ee_edit_event_category',
+						'delete_terms' => 'ee_delete_event_category',
+						'assign_terms' => 'ee_assign_event_category',
+					],
+					'rewrite'           => [
+						'slug' => EEH_URL::slugify(
+							esc_html__('event-category', 'event_espresso'),
+							'event-category'
+						),
+					],
+				],
+			],
+			'espresso_venue_categories' => [
+				'singular_name' => esc_html__('Venue Category', 'event_espresso'),
+				'plural_name'   => esc_html__('Venue Categories', 'event_espresso'),
+				'args'          => [
+					'public'            => true,
+					'show_in_nav_menus' => false, // by default this doesn't show for decaf
+					'show_in_rest'      => true,
+					'capabilities'      => [
+						'manage_terms' => 'ee_manage_venue_categories',
+						'edit_terms'   => 'ee_edit_venue_category',
+						'delete_terms' => 'ee_delete_venue_category',
+						'assign_terms' => 'ee_assign_venue_category',
+					],
+					'rewrite'           => [
+						'slug' => EEH_URL::slugify(
+							esc_html__('venue-category', 'event_espresso'),
+							'venue-category'
+						),
+					],
+				],
+			],
+			'espresso_event_type'       => [
+				'singular_name' => esc_html__('Event Type', 'event_espresso'),
+				'plural_name'   => esc_html__('Event Types', 'event_espresso'),
+				'args'          => [
+					'public'       => true,
+					'show_ui'      => false,
+					'show_in_rest' => true,
+					'capabilities' => [
+						'manage_terms' => 'ee_read_event_type',
+						'edit_terms'   => 'ee_edit_event_type',
+						'delete_terms' => 'ee_delete_event_type',
+						'assign_terms' => 'ee_assign_event_type',
+					],
+					'rewrite'      => [
+						'slug' => EEH_URL::slugify(
+							esc_html__('event-type', 'event_espresso'),
+							'event-type'
+						),
+					],
+					'hierarchical' => true,
+				],
+			],
+		];
+	}
 
 
-    public function getCustomTaxonomyDefinitions(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            // legacy filter applied for now,
-            // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-            apply_filters(
-                'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
-                $this->taxonomies
-            )
-        );
-    }
+	public function getCustomTaxonomyDefinitions(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			// legacy filter applied for now,
+			// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+			apply_filters(
+				'FHEE__EE_Register_CPTs__get_taxonomies__taxonomies',
+				$this->taxonomies
+			)
+		);
+	}
 
 
-    public function getCustomTaxonomySlugs(): array
-    {
-        return array_keys($this->getCustomTaxonomyDefinitions());
-    }
+	public function getCustomTaxonomySlugs(): array
+	{
+		return array_keys($this->getCustomTaxonomyDefinitions());
+	}
 
 
-    /**
-     * By default, WordPress strips all html from term taxonomy description content.
-     * The purpose of this method is to remove that restriction
-     * and ensure that we still run ee term taxonomy descriptions
-     * through some full html sanitization equivalent to the post content field.
-     * So first we remove default filter for term description
-     * but we have to do this earlier before wp sets their own filter
-     * because they just set a global filter on all term descriptions
-     * before the custom term description filter.
-     * Really sux.
-     *
-     * @param string $description The description content.
-     * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
-     * @return string
-     */
-    public function filterCustomTermDescription(string $description, string $taxonomy): string
-    {
-        // get a list of EE taxonomies
-        $custom_taxonomies = $this->getCustomTaxonomySlugs();
-        // only do our own thing if the taxonomy listed is an ee taxonomy.
-        if (in_array($taxonomy, $custom_taxonomies, true)) {
-            // remove default wp filter
-            remove_filter('pre_term_description', 'wp_filter_kses');
-            // sanitize THIS content.
-            $description = wp_kses($description, wp_kses_allowed_html('post'));
-        }
-        return $description;
-    }
+	/**
+	 * By default, WordPress strips all html from term taxonomy description content.
+	 * The purpose of this method is to remove that restriction
+	 * and ensure that we still run ee term taxonomy descriptions
+	 * through some full html sanitization equivalent to the post content field.
+	 * So first we remove default filter for term description
+	 * but we have to do this earlier before wp sets their own filter
+	 * because they just set a global filter on all term descriptions
+	 * before the custom term description filter.
+	 * Really sux.
+	 *
+	 * @param string $description The description content.
+	 * @param string $taxonomy    The taxonomy name for the taxonomy being filtered.
+	 * @return string
+	 */
+	public function filterCustomTermDescription(string $description, string $taxonomy): string
+	{
+		// get a list of EE taxonomies
+		$custom_taxonomies = $this->getCustomTaxonomySlugs();
+		// only do our own thing if the taxonomy listed is an ee taxonomy.
+		if (in_array($taxonomy, $custom_taxonomies, true)) {
+			// remove default wp filter
+			remove_filter('pre_term_description', 'wp_filter_kses');
+			// sanitize THIS content.
+			$description = wp_kses($description, wp_kses_allowed_html('post'));
+		}
+		return $description;
+	}
 }

core/domain/entities/custom_post_types/CustomTaxonomyTerm.php

Indentation +21 added lines, -21 removed lines

@@ -12,35 +12,35 @@
  */
 class CustomTaxonomyTerm
 {
-    public string $taxonomy_slug;
+	public string $taxonomy_slug;
 
-    public string $term_slug;
+	public string $term_slug;
 
-    public array $custom_post_type_slugs;
+	public array $custom_post_type_slugs;
 
 
-    public function __construct(string $taxonomy_slug, string $term_slug, array $custom_post_type_slugs = [])
-    {
-        $this->taxonomy_slug          = $taxonomy_slug;
-        $this->term_slug              = $term_slug;
-        $this->custom_post_type_slugs = $custom_post_type_slugs;
-    }
+	public function __construct(string $taxonomy_slug, string $term_slug, array $custom_post_type_slugs = [])
+	{
+		$this->taxonomy_slug          = $taxonomy_slug;
+		$this->term_slug              = $term_slug;
+		$this->custom_post_type_slugs = $custom_post_type_slugs;
+	}
 
 
-    public function taxonomySlug(): string
-    {
-        return $this->taxonomy_slug;
-    }
+	public function taxonomySlug(): string
+	{
+		return $this->taxonomy_slug;
+	}
 
 
-    public function termSlug(): string
-    {
-        return $this->term_slug;
-    }
+	public function termSlug(): string
+	{
+		return $this->term_slug;
+	}
 
 
-    public function customPostTypeSlugs(): array
-    {
-        return $this->custom_post_type_slugs;
-    }
+	public function customPostTypeSlugs(): array
+	{
+		return $this->custom_post_type_slugs;
+	}
 }